renstar 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ec00844bc41728ecfd92760ee41fc4d46a5f3f774f8dc0cbc775d24ead73c5a
-  data.tar.gz: 927825f1c773ed6f39f04a01a186b560e62d8251b980509b1d0115b3aebbbd80
+  metadata.gz: ec271b5f2fff4930b2689574a8dbffda3a7aa956ee2b251771cb3c37ea3eea99
+  data.tar.gz: c44ba6940104204e8cae7ba9531134e94fa22df79d39b224ae2a92968bcaf2e7
 SHA512:
-  metadata.gz: 0ec1ba6a7196d85a096ebefb15939a7067ced4ae09247b7c897b68021acb72bc40e113584445da2482f1b65607bdc49fd2cd7c09e4e0cc5c28f0eabb70403c76
-  data.tar.gz: d466accc4a177cd0b7e0c739aa76e4d5d93f1f6c81707183e6bfed5e13caef56c0c3fe1f02b097df34177105306afe5e8041bf8284994ca66b93b1470bbbb133
+  metadata.gz: 49c89698f8df31b6f6410af9ab6d0cf2607fb3c637aaa1bd0afb044a33393285614e31b679877e7a9bc6aecc258d830f512203a018adc0ab2b2e903ebeaac0c1
+  data.tar.gz: 92a4ca9dfc653a48bada22b2f0f8d658739b106e116f58ac96872724dc070c5cdb3341b5567c3a67c27c0dbbde42f249662fd81cfa83acd662bd39bedd4bebca

data/.ruby-version

@@ -0,0 +1 @@
+3.0.4

data/README.md

@@ -22,6 +22,10 @@ Or install it yourself as:
 
 ## Using the included binary
 
+Well, OK, it's just a script that uses the library, but it wraps all of the
+functionality and lets you just control your thermostat if that's all you're
+here for.
+
 When installing the gem, we install `renstar.rb` for you automatically. You can
 pass the `-h` flag for more info.
 
@@ -29,17 +33,21 @@ The help page does not list all the accepted commands or their values but all of
 the methods below are supported. The binary just passes your arguments to the
 methods below.
 
-So, if you want to cool your house to 72 using the binary, you can do this:
-```ruby
+So, if you want to cool your house to 72 using the binary, you can do this in
+your favorite shell:
+```bash
 renstar.rb cool 72
 ```
 
 You can apply the logic above to any of the methods below for the same effect.
 
 ### Note about thermostat selection
+
 The binary chooses the first thermostat it finds on the network, so you may get
-unexpected results if you have more than one on your network. I do plan on
-improving this.
+unexpected results if you have more than one on your network.
+
+You can use the `-t` option to pass the hostname or IP address of a thermostat
+if you know it and don't want to wait for autodiscovery to find it.
 
 ## Using the library
 

data/bin/renstar.rb

@@ -1,51 +1,68 @@
+# frozen_string_literal: true
+
 require 'renstar'
 require 'optparse'
 require 'ostruct'
-require 'pry'
 
 options = {}
 
-#DEFAULT_OPTIONS = { all: false }.freeze
+# DEFAULT_OPTIONS = { all: false }.freeze
 
+USAGE = ' Usage: renstar.rb command [value]'
 
-USAGE = " Usage: renstar.rb command [value]"
+Options = Struct.new(:thermostat)
+args = Options.new
 
 OptionParser.new do |opts|
-
   opts.banner = USAGE
 
-  opts.on '-d', '--discover', 'Discover all Renstar devices' do |d|
+  opts.on '-d', '--discover', 'Discover all Renstar devices' do |_d|
     options[:discover] = true
   end
 
-  opts.on '-h', '--help', 'Display this screen' do |h|
+  opts.on '-h', '--help', 'Display this screen' do |_h|
     puts opts
     exit 0
   end
+
+  opts.on '-tTHERMOSTAT', '--thermostat=THERMOSTAT', 'Use thermostat by host name or IP. No discovery.' do |t|
+    args.thermostat = t
+  end
 end.parse!
 
 if options[:discover]
   thermos = Renstar::Thermostat.search
-  thermos.each do |thermo|
-    puts "Found: #{thermo.location} #{thermo.usn}"
+  thermos.each do |t|
+    puts "Found: #{t.location} #{t.usn}"
   end
   exit 0
 end
 
-
-thermos = Renstar::Thermostat.search
-thermos.each do |thermo|
-  puts "Found: #{thermo.location} #{thermo.usn}"
-end
-puts "Using: " + thermos.first.location + " - " + thermos.first.usn
-unless (ARGV.nil? || ARGV.empty?)
-  response = thermos.first.send(*ARGV)
-  case response
-  when String
-    puts response
-  when Renstar::APIClient::APIObject
-    response.pp
-  when Array
-    response.each {|x| x.pp }
+thermo = nil
+if args.thermostat
+  thermo = Renstar::Thermostat.new(args.thermostat)
+  puts "Using: #{thermo.location}"
+else
+  thermos = Renstar::Thermostat.search
+  thermos.each do |t|
+    puts "Found: #{t.location} #{t.usn}"
   end
+  thermo = thermos.first
+  puts "Using: #{thermo.location} - #{thermo.usn}"
+end
+command = nil
+if ARGV.nil? || ARGV.empty?
+  command = 'info'
+else
+  command = ARGV
+end
+
+response = thermo.send(*command)
+case response
+when String
+  puts response
+when Renstar::APIClient::APIObject
+  response.pp
+when Array
+  response.each(&:pp)
 end

data/lib/renstar/api_client/api_object.rb

@@ -31,7 +31,6 @@ module Renstar
                  { description: description, formatted_value: formatted_value })
         end.join
       end
-
     end
   end
 end

data/lib/renstar/api_client/control.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../api_client'
 module Renstar
   module APIClient
     # Interface to the "Control" portion of the Venstar API

data/lib/renstar/api_client/query.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../api_client'
 require_relative 'api_objects/info'
 require_relative 'api_objects/sensor'
 require_relative 'api_objects/runtime'

data/lib/renstar/api_client/settings.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../api_client'
 module Renstar
   module APIClient
     # Interface to the "Settings" portion of the API

data/lib/renstar/thermostat.rb

@@ -12,6 +12,7 @@ module Renstar
   #
   class Thermostat
     SERVICE = 'venstar:thermostat:ecp'
+    USN_REGEX = /^(\w+):(\w+)+:((?:[0-9a-fA-F]{2}:?)+):name:(.*):type:(.*)/
     DEFAULT_TIMEOUT = 3
 
     attr_reader :location, :usn, :cached_info
@@ -19,12 +20,12 @@ module Renstar
     include APIClient
 
     def initialize(location, usn = nil)
-      if location && usn then
+      if location && usn
         @location = location
         @usn = usn
       else
-        @location = "http://" + location + '/'
-        @usn = ""
+        @location = "http://#{location}/"
+        @usn = ''
       end
 
       @cache_timestamp = Time.now
@@ -39,7 +40,7 @@ module Renstar
       end
       ips.each do |ip|
         puts "Searching subnet associated with #{ip.ip_address}"
-        ssdp = SSDP::Consumer.new({bind: ip.ip_address})
+        ssdp = SSDP::Consumer.new({ bind: ip.ip_address })
         thermos = ssdp.search(service: SERVICE, timeout: timeout)
         thermos.each do |thermo|
           location = thermo[:params]['Location']

data/lib/renstar/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Renstar
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

data/renstar.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/mikerodrigues/renstar'
   spec.required_ruby_version = '>= 3.0.0'
 
-  spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/mikerodrigues/renstar'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: renstar
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Michael Rodrigues
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-07 00:00:00.000000000 Z
+date: 2022-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -49,6 +49,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - Gemfile
 - LICENSE
 - README.md