renstar 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c893e454f0d89cfacea09754a34ce55b14b327a821131fa3f91519d4fb82d194
-  data.tar.gz: 8fea02226bfcd4ec43a170d10cf830ed86430e8ccff222ae81de34933215a8c6
+  metadata.gz: ec271b5f2fff4930b2689574a8dbffda3a7aa956ee2b251771cb3c37ea3eea99
+  data.tar.gz: c44ba6940104204e8cae7ba9531134e94fa22df79d39b224ae2a92968bcaf2e7
 SHA512:
-  metadata.gz: 66f8f9dd14a24154e426a77fb27bbf907390751e7291a36b88078b4be451b1e264095482b0d5336dfe587837d69e18cf0d573af2b00d65f13402e88b5b8f21d9
-  data.tar.gz: b80c4954be1b7ca521c7ccf0d630b84215e1480082cbd0deabe2408b964d21c72d509826366efc671c682f473e2e6250cbb23985b590a32b82bd5bcfab17487e
+  metadata.gz: 49c89698f8df31b6f6410af9ab6d0cf2607fb3c637aaa1bd0afb044a33393285614e31b679877e7a9bc6aecc258d830f512203a018adc0ab2b2e903ebeaac0c1
+  data.tar.gz: 92a4ca9dfc653a48bada22b2f0f8d658739b106e116f58ac96872724dc070c5cdb3341b5567c3a67c27c0dbbde42f249662fd81cfa83acd662bd39bedd4bebca

data/.ruby-version

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

data/Gemfile

@@ -6,4 +6,3 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake', '~> 13.0'
-gem 'ssdp', git: 'https://github.com/mikerodrigues/ssdp'

data/README.md

@@ -20,13 +20,74 @@ Or install it yourself as:
 
     $ gem install renstar
 
-## Usage
+## 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.
+
+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 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.
+
+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
+
+First we need to create a `Thermostat` object.
 
 * Search for thermostats on the LAN, return the first one found:
 ```ruby
 thermo = Renstar::Thermostat.search.first
 ```
 
+### Query
+
+These methods let you see the thermostat info (controls and settings status), sensor info, runtimes, and
+alerts.
+
+* Get information about the thermostat:
+```ruby
+thermo.info
+```
+
+* Get the current sensors and their readings:
+```ruby
+thermo.sensors
+```
+
+* Get runtimes:
+```ruby
+thermo.runtimes
+```
+
+* See alerts and their status:
+```ruby
+thermo.alerts
+```
+
+### Control
+
+These methods let you control the thermostat temperature controls, and fan. You
+can use the `info` method to check the current state of these controls.
+
 * Heat to 80 degrees:
 ```ruby
 thermo.heat(80)
@@ -42,7 +103,7 @@ thermo.cool(60)
 thermo.auto(70, 74)
 ```
 
-* Turn off heeating and/or cooling
+* Turn off heating and/or cooling
 ```ruby
 thermo.off
 ```
@@ -56,7 +117,13 @@ thermo.fan_off
 thermo.fan_toggle
 ```
 
-* Control the schedule:
+### Settings
+
+These methods let you change the schedule and vacation settings on your
+thermostat. You can use the `info` method to check the current state of the
+settings.
+
+* Set the schedule:
 ```ruby
 thermo.schedule_on
 
@@ -72,8 +139,6 @@ thermo.home
 thermo.away
 ```
 
-
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/renstar.rb

@@ -1,42 +1,68 @@
+# frozen_string_literal: true
+
 require 'renstar'
 require 'optparse'
 require 'ostruct'
 
 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}"
+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
-puts "Using: " + thermos.first.location + " - " + thermos.first.usn
-unless (ARGV.nil? || ARGV.empty?)
-  puts thermos.first.send(*ARGV)
+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

@@ -23,18 +23,14 @@ module Renstar
         @raw_hash
       end
 
-      def human_readable
+      def human_readable(type)
         @raw_hash.map do |key, value|
-          description = APIClient.key_to_description('runtimes', key)
-          formatted_value = APIClient.value_to_formatted('runtimes', key, value)
+          description = APIClient.key_to_description(type, key)
+          formatted_value = APIClient.value_to_formatted(type, key, value)
           format("%-35<description>s %<formatted_value>s\n",
                  { description: description, formatted_value: formatted_value })
         end.join
       end
-
-      def pp
-        puts human_readable
-      end
     end
   end
 end

data/lib/renstar/api_client/api_objects/alert.rb

@@ -8,6 +8,9 @@ module Renstar
     # These alerts are for Air filter, Service, and UV Lamp
     #
     class Alert < APIObject
+      def pp
+        puts human_readable('alerts')
+      end
     end
   end
 end

data/lib/renstar/api_client/api_objects/info.rb

@@ -9,6 +9,9 @@ module Renstar
     # info response from the API for clean access.
     #
     class Info < APIObject
+      def pp
+        puts human_readable('info')
+      end
     end
   end
 end

data/lib/renstar/api_client/api_objects/runtime.rb

@@ -8,6 +8,9 @@ module Renstar
     # Breaks down how much time the system spent in various states
     # like heating or cooling.
     class Runtime < APIObject
+      def pp
+        puts human_readable('runtimes')
+      end
     end
   end
 end

data/lib/renstar/api_client/api_objects/sensor.rb

@@ -7,6 +7,9 @@ module Renstar
     # Represents an installed sensor in the system
     # Returns the value of the sensor
     class Sensor < APIObject
+      def pp
+        puts human_readable('sensors')
+      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.2.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'
@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'json'
-  spec.add_runtime_dependency 'ssdp', '~> 1.1.7'
+  spec.add_runtime_dependency 'ssdp', '~> 1.2.0'
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: renstar
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Michael Rodrigues
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-06 00:00:00.000000000 Z
+date: 2022-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.7
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.7
+        version: 1.2.0
 description: Control Venstar thermostats with Ruby via their local API.
 email:
 - mikebrodrigues@gmail.com
@@ -49,6 +49,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - Gemfile
 - LICENSE
 - README.md
@@ -91,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: Control Venstar thermostats.