renstar 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 395939a21c7674830297c4b637980c6b0ef8dd5a368ac9c7f22046e8acd30f8d
-  data.tar.gz: 76fcd3f4913478ca1993f8b0b9acfd27ab420f23005f55803a98955d5b196a5a
+  metadata.gz: 5ec00844bc41728ecfd92760ee41fc4d46a5f3f774f8dc0cbc775d24ead73c5a
+  data.tar.gz: 927825f1c773ed6f39f04a01a186b560e62d8251b980509b1d0115b3aebbbd80
 SHA512:
-  metadata.gz: 85342777ce38973500afc97c66c059c3b8b0e6b023367902d2271b3ece751a2f40c9840fc44e27c792fdf08a86f41467494e07aecc86dfbaa481b6cf471fd2c5
-  data.tar.gz: a30e766bb836c2e682f3f4b4499d8e77aea7cb7cb90e1ac44c8a61398df9e0657223b7e136ccf27cc8512bace3cec41e80e7f238247f6576774b414503194bbb
+  metadata.gz: 0ec1ba6a7196d85a096ebefb15939a7067ced4ae09247b7c897b68021acb72bc40e113584445da2482f1b65607bdc49fd2cd7c09e4e0cc5c28f0eabb70403c76
+  data.tar.gz: d466accc4a177cd0b7e0c739aa76e4d5d93f1f6c81707183e6bfed5e13caef56c0c3fe1f02b097df34177105306afe5e8041bf8284994ca66b93b1470bbbb133

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,66 @@ 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.
+
+### 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.
+
+## 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 +95,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 +109,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 +131,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

@@ -39,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.0'
+  VERSION = '0.3.1'
 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.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.0
+  version: 0.3.1
 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
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ssdp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 description: Control Venstar thermostats with Ruby via their local API.
 email:
 - mikebrodrigues@gmail.com
@@ -77,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.