cosmosc2-kasa-plug 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 146ebc6050d7cfa29d272af27814cae1eb3de6ce1e4da13cb70703eca05ad0c4
+  data.tar.gz: a2e9f4ab507e3eb05e0b4b16621efd62b1b264fc597854c61643568d1648cf8c
+SHA512:
+  metadata.gz: 9bad9abc5595c0aabf88c00d8af47c4c3636d36f2257377ec5f379979cf9827e10453b2b538418777a844d35f199c87b73f46fb3966623dd69465a3c0ddd14a3
+  data.tar.gz: 49336d1f6079d2ea368aa7a9088533bb9adc41d11476bb14d84256421aa644aa7511ae78a0453e09bf3bf24732cda71f7826a6a70927b53cf38f0b92ed865bf7

data/LICENSE.txt

@@ -0,0 +1,9 @@
+The MIT License
+
+Copyright 2021 Ryan Melton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,24 @@
+## COSMOS v5 Kasa Plug Plugin
+
+This plugin provides an Interface and Target for connecting to Kasa / TP-Link Smart Home Wifi Plugs
+
+## Getting Started
+
+1. Plug in your Kasa Plug and connect it to your Wifi network using the Kasa App
+
+2. Determine the IP Address of Your Kasa Plug using Your Home Router (or other methods)
+
+3. Install the plugin .gem file to the COSMOS Admin Page and Enter the IP Address
+
+## Contributing
+
+Contributing is easy.
+
+1. Fork the project
+2. Create a feature branch
+3. Make your changes
+4. Submit a pull request
+
+## License
+
+The MIT License - See LICENSE.txt

data/Rakefile

@@ -0,0 +1,34 @@
+# encoding: ascii-8bit
+
+# Copyright 2021 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# This program may also be used under the terms of a commercial or
+# enterprise edition license of COSMOS if purchased from the
+# copyright holder
+
+PLUGIN_NAME = Dir['*.gemspec'][0].split('.')[0..-2].join('.')
+
+task :warn_version do
+  unless ENV['VERSION']
+    puts "Warning: VERSION is required for releases: rake <task> VERSION=X.X.X"
+  end
+end
+
+task :build => [:warn_version] do
+  _, platform, *_ = RUBY_PLATFORM.split("-")
+  if platform == 'mswin32' or platform == 'mingw32'
+    puts "Warning: Building gem on Windows will lose file permissions"
+  end
+  system("gem build #{PLUGIN_NAME}")
+end

data/plugin.txt

@@ -0,0 +1,9 @@
+VARIABLE target_name PLUG
+VARIABLE int_name PLUG_INT
+VARIABLE ip 192.168.1.0
+VARIABLE port 9999
+
+TARGET PLUG <%= target_name %>
+
+INTERFACE <%= int_name %> kasa_interface.rb <%= ip %> <%= port %>
+  MAP_TARGET <%= target_name %>

data/targets/PLUG/cmd_tlm/plug_cmds.txt

@@ -0,0 +1,16 @@
+COMMAND <%= target_name %> INFO BIG_ENDIAN "Gets the telemetry from the plug"
+  DISABLE_MESSAGES
+  APPEND_ID_PARAMETER DATA 0 STRING '{"system":{"get_sysinfo":{}}}' "Info Command to Plug"
+
+COMMAND <%= target_name %> ON BIG_ENDIAN "Turns the plug on"
+  APPEND_ID_PARAMETER DATA 0 STRING '{"system":{"set_relay_state":{"state":1}}}' "On Command to Plug"
+
+COMMAND <%= target_name %> OFF BIG_ENDIAN "Turns the plug off"
+  APPEND_ID_PARAMETER DATA 0 STRING '{"system":{"set_relay_state":{"state":0}}}' "Off Command to Plug"
+
+COMMAND <%= target_name %> LED_ON BIG_ENDIAN "Turns the plugs led on"
+  APPEND_ID_PARAMETER DATA 0 STRING '{"system":{"set_led_off":{"off":0}}}' "Info Command to Plug"
+
+COMMAND <%= target_name %> LED_OFF BIG_ENDIAN "Turns the plugs led off"
+  APPEND_ID_PARAMETER DATA 0 STRING '{"system":{"set_led_off":{"off":1}}}' "Info Command to Plug"
+

data/targets/PLUG/cmd_tlm/plug_tlm.txt

@@ -0,0 +1,11 @@
+TELEMETRY <%= target_name %> STATUS BIG_ENDIAN "Status of the Plug"
+  APPEND_ID_ITEM PACKET_ID 8 UINT 1 "Packet Id"
+  APPEND_ITEM RELAY 8 UINT "Relay State"
+    STATE ON 1
+    STATE OFF 0
+  APPEND_ITEM LED 8 UINT "LED State"
+    STATE ON 1
+    STATE OFF 0
+
+TELEMETRY <%= target_name %> RESPONSE BIG_ENDIAN "Response from the Plug"
+  APPEND_ITEM DATA 0 STRING "Response data"

data/targets/PLUG/lib/kasa_interface.rb

@@ -0,0 +1,127 @@
+# encoding: ascii-8bit
+
+require 'cosmos'
+require 'cosmos/interfaces/tcpip_client_interface'
+require 'json'
+require_relative 'kasa_protocol'
+
+module Cosmos
+  class KasaInterface < TcpipClientInterface
+    def initialize (hostname, port, polling_period_seconds = 30, write_timeout = 10.0, read_timeout = nil)
+      super(hostname, port, port, write_timeout, read_timeout, 'LENGTH', 0, 32, 4)
+      add_protocol(KasaProtocol, [], :READ_WRITE)
+      @status_packet = nil
+      @polling_period_seconds = polling_period_seconds.to_i
+      @polling_thread = nil
+      @polling_thread_run = true
+      @polling_thread_sleeper = nil
+    end
+
+    def connect
+      super()
+
+      if @polling_period_seconds > 0
+        @polling_thread_run = true
+        @polling_thread_sleeper = Sleeper.new
+        @polling_thread = Thread.new do 
+          while @polling_thread_run
+            send_info_command()
+            break if @polling_thread_sleeper.sleep(@polling_period_seconds)
+          end
+        rescue => err
+          Logger.instance.error("Polling thread unexpectedly died : #{@name}")
+          raise err
+        end
+      end
+    end
+
+    def disconnect
+      if @polling_thread
+        @polling_thread_run = false
+        @polling_thread_sleeper.cancel
+        @polling_thread.join
+        @polling_thread = nil
+        @polling_thread_sleeper = nil
+      end
+      super()
+    end
+
+    def write(packet)
+      result = super(packet)
+      # Follow every non-INFO command with an INFO command
+      send_info_command() if packet.packet_name != 'INFO'
+      return result
+    end
+
+    def read
+      if @status_packet
+        packet = @status_packet
+        @status_packet = nil
+        return packet
+      end
+      packet = super()
+
+      # Info Command Results Format
+      # {
+      #   "system":
+      #   {
+      #     "get_sysinfo":
+      #     {
+      #       "sw_ver":"1.0.3 Build 201015 Rel.142523",
+      #       "hw_ver":"5.0","model":"HS103(US)",
+      #       "deviceId":"8006E861C909AAF4BABED171339873F91E67E71C",
+      #       "oemId":"211C91F3C6FA93568D818524FE170CEC",
+      #       "hwId":"B25CBC5351DD892EA69AB42199F59E41",
+      #       "rssi":-51,
+      #       "latitude_i":400299,
+      #       "longitude_i":-1050636,
+      #       "alias":"Plug1",
+      #       "status":"new",
+      #       "mic_type":"IOT.SMARTPLUGSWITCH",
+      #       "feature":"TIM",
+      #       "mac":"00:31:92:43:F4:35",
+      #       "updating":0,
+      #       "led_off":1,
+      #       "relay_state":0,
+      #       "on_time":0,
+      #       "icon_hash":"",
+      #       "dev_name":"Smart Wi-Fi Plug Mini",
+      #       "active_mode":"none",
+      #       "next_action":{"type":-1},
+      #       "err_code":0
+      #     }
+      #   }
+      # }
+
+      if packet
+        json_hash = JSON.parse(packet.buffer(false))
+        system = json_hash['system']
+        if system
+          get_sysinfo = system['get_sysinfo']
+          if get_sysinfo
+            @status_packet = System.telemetry.packet(@target_names[0], 'STATUS')
+            @status_packet.write('PACKET_ID', 1)
+            relay = get_sysinfo['relay_state']
+            @status_packet.write('RELAY', relay)
+            led_off = get_sysinfo['led_off']
+            if led_off == 0
+              led = 1
+            else
+              led = 0
+            end
+            @status_packet.write('LED', led)
+            @status_packet.received_time = nil
+          end
+        end
+      end
+
+      return packet
+    end
+
+    def send_info_command
+      info_command = System.commands.packet(@target_names[0], 'INFO').dup
+      info_command.restore_defaults
+      write(info_command)
+    end
+  end
+end

data/targets/PLUG/lib/kasa_protocol.rb

@@ -0,0 +1,43 @@
+# encoding: ascii-8bit
+
+require 'cosmos/interfaces/protocols/protocol'
+
+module Cosmos
+
+  # Performs the TPLink SmartHome Protocol
+  class KasaProtocol < Protocol
+
+    def read_data(data)
+      return super(data) if data.length <= 0
+      return kasa_decode(data)
+    end
+
+    def write_data(data)
+      return kasa_encode(data)
+    end
+
+    def kasa_encode(string)
+      key = 171
+      result = [string.length].pack("N")
+      string.each_byte do |byte|
+        a = key ^ byte
+        key = a
+        result << a
+      end
+      return result
+    end
+
+    def kasa_decode(string)
+      key = 171
+      result = ""
+      string[4..-1].each_byte do |byte|
+        a = key ^ byte
+        key = byte
+        result << [a].pack("C")
+      end
+      return result
+    end
+
+  end
+
+end

data/targets/PLUG/screens/status.txt

@@ -0,0 +1,5 @@
+SCREEN AUTO AUTO 1
+
+TITLE "<%= target_name %> STATUS"
+LABELVALUE <%= target_name %> STATUS RELAY
+LABELVALUE <%= target_name %> STATUS LED

data/targets/PLUG/target.txt

@@ -0,0 +1,5 @@
+REQUIRE kasa_interface.rb
+
+# Ignored Parameters
+# IGNORE_PARAMETER parameter_name
+IGNORE_PARAMETER DATA

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: cosmosc2-kasa-plug
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ryan Melton
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cosmos
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "    This plugin an Interface and Target to Connect COSMOS to a Kasa
+  Smart Plug\n"
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- plugin.txt
+- targets/PLUG/cmd_tlm/plug_cmds.txt
+- targets/PLUG/cmd_tlm/plug_tlm.txt
+- targets/PLUG/lib/kasa_interface.rb
+- targets/PLUG/lib/kasa_protocol.rb
+- targets/PLUG/screens/status.txt
+- targets/PLUG/target.txt
+homepage: https://github.com/ryanmelt/cosmosc2-kasa-plug
+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: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: COSMOS Plugin to Connect to Kasa Smart Plugs
+test_files: []