renstar 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c893e454f0d89cfacea09754a34ce55b14b327a821131fa3f91519d4fb82d194
-  data.tar.gz: 8fea02226bfcd4ec43a170d10cf830ed86430e8ccff222ae81de34933215a8c6
+  metadata.gz: 6e0023780425b4b2d649ffaaf881630adb1485a8c54e58934f69c31ba4953bd5
+  data.tar.gz: ebbef10e2b31c0c51aa5de4c8b02b82ec6f5d29be6d4526f4ec15c5cbdffde62
 SHA512:
-  metadata.gz: 66f8f9dd14a24154e426a77fb27bbf907390751e7291a36b88078b4be451b1e264095482b0d5336dfe587837d69e18cf0d573af2b00d65f13402e88b5b8f21d9
-  data.tar.gz: b80c4954be1b7ca521c7ccf0d630b84215e1480082cbd0deabe2408b964d21c72d509826366efc671c682f473e2e6250cbb23985b590a32b82bd5bcfab17487e
+  metadata.gz: d36ebe45f2767dc4ed9f45f1299828004985fffe6c790913e5a1fad386ba23a59fd25347bb746ce0a2f9d8a88a448c952bfa707d77cfed9522e131477fc6f968
+  data.tar.gz: 4ae3c1982c6df2f82e05f45410002259df1a8c21113039dc4d9d4b2484819d432e2584109eb72683a3684e46d55519fe79b3342047904a32c68c7dae5c97db9f

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,7 +112,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 +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,6 +1,7 @@
 require 'renstar'
 require 'optparse'
 require 'ostruct'
+require 'pry'
 
 options = {}
 
@@ -38,5 +39,13 @@ thermos.each do |thermo|
 end
 puts "Using: " + thermos.first.location + " - " + thermos.first.usn
 unless (ARGV.nil? || ARGV.empty?)
-  puts thermos.first.send(*ARGV)
+  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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: renstar
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Michael Rodrigues
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-06 00:00:00.000000000 Z
+date: 2022-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -91,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.