renstar 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3651f4b220453c1382ee4accc5503a1122364672acee6590366adcfe0bc911c9
-  data.tar.gz: 7355ee293bca9e280004a799198c107c060c555dfff9913215c757d678ef67cc
+  metadata.gz: 6e0023780425b4b2d649ffaaf881630adb1485a8c54e58934f69c31ba4953bd5
+  data.tar.gz: ebbef10e2b31c0c51aa5de4c8b02b82ec6f5d29be6d4526f4ec15c5cbdffde62
 SHA512:
-  metadata.gz: d216511fa715d06164f923d0d923312d7c515f7c97f9395bb91fa90dec0cbc416fbcc935e338d4b08b20f518236a4a3bc55a8766d470c1b2a501fedb1ee67884
-  data.tar.gz: 56077d08ddc62d53d365999ac75fe552aeb8cf52222f97b3ba8fe4ce5de9a9ebc0f04546803fbb9df422ae51187bff0cc20ae30e682dbdfb3f2bce6cc647df14
+  metadata.gz: d36ebe45f2767dc4ed9f45f1299828004985fffe6c790913e5a1fad386ba23a59fd25347bb746ce0a2f9d8a88a448c952bfa707d77cfed9522e131477fc6f968
+  data.tar.gz: 4ae3c1982c6df2f82e05f45410002259df1a8c21113039dc4d9d4b2484819d432e2584109eb72683a3684e46d55519fe79b3342047904a32c68c7dae5c97db9f

data/Gemfile

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

data/README.md

@@ -20,13 +20,69 @@ Or install it yourself as:
 
     $ gem install renstar
 
-## Usage
+## Using the included binary
+
+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:
+```ruby
+renstar.rb cool 72
+```
+
+You can apply the logic above to any of the methods below for the same effect.
+
+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.
+
+You may have trouble with discovery on multi-homed hosts, but I'm working with
+the author of the `ssdp` library to fix this, so I expect it to improve. You can
+install my fork of `ssdp` from github if you need multi-homed support now.
+
+## 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 +98,7 @@ thermo.cool(60)
 thermo.auto(70, 74)
 ```
 
-* Turn off heeating and/or cooling
+* Turn off heating and/or cooling
 ```ruby
 thermo.off
 ```
@@ -56,11 +112,17 @@ 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
 
-thermo.scheduel_off
+thermo.schedule_off
 
 thermo.schedule_toggle
 ```
@@ -72,8 +134,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,50 +1,51 @@
 require 'renstar'
 require 'optparse'
 require 'ostruct'
+require 'pry'
 
-class RenstarOptions
-  DEFAULT_OPTIONS = { all: false }.freeze
-  USAGE = " Usage: renstar.rb command [value]"
+options = {}
 
-  def self.parse(args)
+#DEFAULT_OPTIONS = { all: false }.freeze
 
-    @options = OpenStruct.new(DEFAULT_OPTIONS)
 
-    options = OptionParser.new do |opts|
-      opts.banner = USAGE
+USAGE = " Usage: renstar.rb command [value]"
 
-      opts.on '-d', '--discover', 'Discover all Renstar devices' do |d|
-        @options.discover = true
-      end
+OptionParser.new do |opts|
 
-      opts.on '-h', '--help', 'Display this screen' do |h|
-        @options.help = true
-      end
-    end
+  opts.banner = USAGE
 
-    options.parse!(args)
-
-    puts options if @options && ARGV == []
-
-    if @options.discover
-      Renstar.discover.each do |device|
-        puts "#{device.name} #{device.ip}"
-      end
-      exit 0
-    end
-
-    if @options.help
-      puts opts
-      exit 0
-    end
+  opts.on '-d', '--discover', 'Discover all Renstar devices' do |d|
+    options[:discover] = true
+  end
 
+  opts.on '-h', '--help', 'Display this screen' do |h|
+    puts opts
+    exit 0
+  end
+end.parse!
 
+if options[:discover]
+  thermos = Renstar::Thermostat.search
+  thermos.each do |thermo|
+    puts "Found: #{thermo.location} #{thermo.usn}"
   end
+  exit 0
 end
 
-@options = RenstarOptions.parse(ARGV)
 
-thermo = Renstar::Thermostat.search.first
-
-
-thermo.send(*ARGV)
+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 }
+  end
+end

data/lib/renstar/api_client/api_object.rb

@@ -23,18 +23,15 @@ 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/thermostat.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'ssdp'
+require 'socket'
 require_relative 'api_client'
 
 module Renstar
@@ -11,27 +12,42 @@ module Renstar
   #
   class Thermostat
     SERVICE = 'venstar:thermostat:ecp'
-    DEFAULT_TIMEOUT = 5
+    DEFAULT_TIMEOUT = 3
 
     attr_reader :location, :usn, :cached_info
 
     include APIClient
 
-    def initialize(location, usn)
-      @location = location
-      @usn = usn
+    def initialize(location, usn = nil)
+      if location && usn then
+        @location = location
+        @usn = usn
+      else
+        @location = "http://" + location + '/'
+        @usn = ""
+      end
+
       @cache_timestamp = Time.now
       @cached_info = info
     end
 
     def self.search(timeout = DEFAULT_TIMEOUT)
-      ssdp = SSDP::Consumer.new
-      thermos = ssdp.search(service: SERVICE, timeout: timeout)
-      thermos.map do |thermo|
-        location = thermo[:params]['Location']
-        usn = thermo[:params]['USN']
-        Renstar::Thermostat.new(location, usn)
+      all_thermos = []
+      ips = Socket.ip_address_list.select do |ip|
+        ip.ipv4? &&
+          !ip.ipv4_loopback?
+      end
+      ips.each do |ip|
+        puts "Searching subnet associated with #{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']
+          usn = thermo[:params]['USN']
+          all_thermos << Renstar::Thermostat.new(location, usn)
+        end
       end
+      all_thermos
     end
 
     def update

data/lib/renstar/version.rb

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

data/renstar.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'json'
-  spec.add_runtime_dependency 'ssdp'
+  spec.add_runtime_dependency 'ssdp', '~> 1.1.7'
 
   # 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.1.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Michael Rodrigues
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-21 00:00:00.000000000 Z
+date: 2022-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -28,16 +28,16 @@ dependencies:
   name: ssdp
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.7
 description: Control Venstar thermostats with Ruby via their local API.
 email:
 - mikebrodrigues@gmail.com
@@ -50,7 +50,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -92,7 +91,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.

data/Gemfile.lock

@@ -1,23 +0,0 @@
-PATH
-  remote: .
-  specs:
-    renstar (0.1.1)
-      json
-      ssdp
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    json (2.6.1)
-    rake (13.0.6)
-    ssdp (1.1.7)
-
-PLATFORMS
-  x86_64-linux
-
-DEPENDENCIES
-  rake (~> 13.0)
-  renstar!
-
-BUNDLED WITH
-   2.2.22