renstar 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef74d1acc32dc347fad041438f853371966a19c4bd779ffd26fcf95bab9736cf
-  data.tar.gz: 4762e30fee9e46d2da3f3ddd21ea4fe997eba6f1d749abb663e89332909bbd7a
+  metadata.gz: 617260529f9b3d241c8b6f0a4489d9eac7f871a998b9f2e0b42c0ee54e322491
+  data.tar.gz: 3a7560d9559b8c40272a991449bf6d06916fccd4dbc7914e98a5c58d0c84bdd9
 SHA512:
-  metadata.gz: b0c13d294cec82dcf96ac4508108af60286130bf603f770cff3f9994e1131c26c3623d04d3f89b6a9a3e495e9da054b862b94a540840389426f82672860fb386
-  data.tar.gz: 8675dde8fcafa72ccb7d6a3721fcbeb38576a863d840713b0199ca12cb2789a7138244203febab11496e4bff8914f9d4100f4ecbe7f0ea305cce7c8f3938143d
+  metadata.gz: 83fd7c65c7162f8c6c9582a6c8525aa49f14c4c578b56e866581fff21fcfa554afe387396ef399d800993787ec378a1066f3da5cb39ee086a5675e9cc188c119
+  data.tar.gz: 1bcf749dad62edddb0d6be3b4c8e081eb08bdef1ad4389bc86b372ad7fb6e3bef6d3369764f8c157d19c6b76f1de21b10bd1444c0098edd2e211f30cfb4b9b7b

data/bin/renstar.rb

@@ -8,30 +8,30 @@ options = {}
 
 # DEFAULT_OPTIONS = { all: false }.freeze
 
-USAGE = ''' Usage: renstar.rb command [value]
+USAGE = ' Usage: renstar.rb command [value]
 
     Informational Commands:
-      info - Show current settings
-      sensors - Show current Sensor reading
-      runtimes - Last 7 days of usage times
-      alerts - Show alerts and their statuses
-    
+      info     - Show current settings
+      sensors  - Show current Sensor reading
+      runtimes - Show last 7 days of usage times
+      alerts   - Show alerts and their statuses
+
     Control Commands:
      Note: Temp values are integers. Device settings determine units.
-      heat $TEMP - Heat to $TEMP
-      cool $TEMP - Cool to $TEMP
+      heat $TEMP             - Heat to $TEMP
+      cool $TEMP             - Cool to $TEMP
       auto $LO_TEMP $HI_TEMP - Keep temp in between two temps
-      off - Turn off heating and/or cooling
-      fan_on - Turn on the fan
-      fan_off - Turn on the fan
-      fan_toggle - Toggle the fan on/off
-      schedule_on - Turn on the schedule
-      schedule_off - Turn off the schedule
-      schedule_toggle - Toggle the schedule on/off
-      home - Set "Home"
-      away - Set "Away"
+      off                    - Turn off heating and/or cooling
+      fan_on                 - Turn on the fan
+      fan_off                - Turn on the fan
+      fan_toggle             - Toggle the fan on/off
+      schedule_on            - Turn on the schedule
+      schedule_off           - Turn off the schedule
+      schedule_toggle        - Toggle the schedule on/off
+      home                   - Set "Home"
+      away                   - Set "Away"
 
-'''
+'
 
 Options = Struct.new(:thermostat)
 args = Options.new
@@ -67,18 +67,21 @@ if args.thermostat
   puts "Using: #{thermo.location}"
 else
   thermos = Renstar::Thermostat.search
+  if thermos.empty?
+    puts 'No thermostats found'
+    exit 0
+  end
   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
+command = if ARGV.nil? || ARGV.empty?
+            'info'
+          else
+            ARGV
+          end
 
 response = thermo.send(*command)
 case response

data/lib/renstar/api_client/api_object.rb

@@ -7,14 +7,11 @@ module Renstar
       def initialize(raw_hash)
         @raw_hash = raw_hash
         raw_hash.each do |key, value|
-          if key == 'ts'
-            instance_variable_set("@#{key}", Time.at(value))
-          else
-            instance_variable_set("@#{key}", value)
-          end
+          value = Time.at(value) if key == 'ts'
+          instance_variable_set("@#{key}", value)
 
           define_singleton_method(key) do
-            return instance_variable_get("@#{key}")
+            instance_variable_get("@#{key}")
           end
         end
       end

data/lib/renstar/discovery.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'ssdp'
+require 'socket'
+
+module Renstar
+  # Helper module for handling SSDP and IP details for discovery thermostats on
+  # the network
+  module Discovery
+    # Discovery timeout when searching for thermostats
+    DEFAULT_TIMEOUT = 3
+    SERVICE = 'venstar:thermostat:ecp'
+
+    def search(timeout = DEFAULT_TIMEOUT)
+      all_thermos = []
+      ips.each do |ip|
+        all_thermos << ssdp_search(ip, timeout)
+      end
+      all_thermos.flatten
+    end
+
+    private
+
+    def ips
+      Socket.ip_address_list.select do |ip|
+        ip.ipv4? && !ip.ipv4_loopback?
+      end
+    end
+
+    # do an SSDP search using the given IP from a found local interface
+    def ssdp_search(ip, timeout = DEFAULT_TIMEOUT)
+      puts "Searching subnet associated with #{ip.ip_address}"
+      ssdp = SSDP::Consumer.new({ bind: ip.ip_address })
+      thermos = ssdp.search(service: SERVICE, timeout: timeout)
+      thermos.map do |thermo|
+        location = thermo[:params]['Location']
+        usn = thermo[:params]['USN']
+        Renstar::Thermostat.new(location, usn)
+      end
+    end
+  end
+end

data/lib/renstar/thermostat.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-require 'ssdp'
-require 'socket'
 require_relative 'api_client'
+require_relative 'discovery'
 
 module Renstar
   # Thermostat object
@@ -11,13 +10,12 @@ module Renstar
   # Home/Away, and Off
   #
   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
 
     include APIClient
+    extend Discovery
 
     def initialize(location, usn = nil)
       if location && usn
@@ -32,25 +30,6 @@ module Renstar
       @cached_info = info
     end
 
-    def self.search(timeout = DEFAULT_TIMEOUT)
-      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
       @cache_timestamp = Time.now
       @cached_info = info
@@ -113,11 +92,7 @@ module Renstar
     end
 
     def fan_toggle
-      if @cached_info.fan == 1
-        fan_off
-      else
-        fan_on
-      end
+      @cached_info.fan == 1 ? fan_off : fan_on
     end
 
     def schedule_off
@@ -133,11 +108,7 @@ module Renstar
     end
 
     def schedule_toggle
-      if @cached_info.schedule == 1
-        schedule_off
-      else
-        schedule_on
-      end
+      @cached_info.schedule == 1 ? schedule_off : schedule_on
     end
 
     def home

data/lib/renstar/version.rb

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

data/lib/renstar.rb

@@ -3,6 +3,7 @@
 require_relative 'renstar/version'
 require_relative 'renstar/thermostat'
 require_relative 'renstar/api_client'
+require_relative 'renstar/discovery'
 
 module Renstar
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: renstar
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.3
 platform: ruby
 authors:
 - Michael Rodrigues
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-24 00:00:00.000000000 Z
+date: 2023-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -68,6 +68,7 @@ files:
 - lib/renstar/api_client/control.rb
 - lib/renstar/api_client/query.rb
 - lib/renstar/api_client/settings.rb
+- lib/renstar/discovery.rb
 - lib/renstar/thermostat.rb
 - lib/renstar/version.rb
 - renstar.gemspec