htcc 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d2ac4838a69bf4dcef314f14059014aa627f6429c0e44c19b9c0ea546e0dd7c
-  data.tar.gz: 65c2a961af5a31027197d28a6b7b65a3f9ed5d15ab3951a6cbd51911f226b939
+  metadata.gz: 41cf4b7e6fb39144a8cdb77b69f5db8a1e13eef9d0260abe654336682e06a65b
+  data.tar.gz: 742de511fe3af1fb251c40022de0991559ce80f40abd30550ff850ef9c2cdb22
 SHA512:
-  metadata.gz: 7a535e2721b5aa8cf986dca91d3e2f357dcc46e7803578c5fef580bef0f4f94b473b5d00eb12229fcbbe5b419058f6fb828c88c04434a2ce5168ac43ebebb08b
-  data.tar.gz: e6b2d3659b08d587a807e5696819a2c92c7004ad8d99e0b6bce5d2f966a05411986bed45b83a599a451a41cd6557d6c496a821ab23aa8b031335f1f10809649f
+  metadata.gz: 0f08bee8865ffb4c81048e016e0e475556faec9565d6bf1996bf00b888b97f371881b80b91fd0dfa39db259a4d51aec8daedd17a95d786aa64c0cf08599338cf
+  data.tar.gz: 45d37ca81112ea7ac68784e25177e208505884c9a12e822187bc7d6f5cf044b937df42c23f603385ea89e72fd3e020466d39804251b99a9c64dc1f5d94de1397

data/htcc.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'htcc'
-  s.version     = '0.3.0'
+  s.version     = '0.3.1'
   s.summary     = "A Ruby client for the Honeywell Total Connect Comfort API"
   s.description = "This gem can be used to control Honeywell thermostats that use the Total Connect Comfort platform."
   s.author      = 'Lee Folkman'

data/lib/htcc/thermostat.rb

@@ -2,10 +2,36 @@
 
 module HTCC
   class Thermostat
-    SYSTEM_MODES = %i[emergency_heat heat off cool auto]
-    FAN_MODES = %i[auto on circulate schedule]
-    HOLD_TYPES = %i[none temporary permanent]
-    EQUIPMENT_OUTPUT_STATUS = %i[off heating cooling fan_running]
+    SYSTEM_MODES = %i[emergency_heat heat off cool auto].freeze
+    FAN_MODES = %i[auto on circulate schedule].freeze
+    HOLD_TYPES = %i[none temporary permanent].freeze
+    EQUIPMENT_OUTPUT_STATUS = %i[off heating cooling fan_running].freeze
+    HOLD_TIMES = [
+      '00:00', '00:15', '00:30', '00:45',
+      '01:00', '01:15', '01:30', '01:45',
+      '02:00', '02:15', '02:30', '02:45',
+      '03:00', '03:15', '03:30', '03:45',
+      '04:00', '04:15', '04:30', '04:45',
+      '05:00', '05:15', '05:30', '05:45',
+      '06:00', '06:15', '06:30', '06:45',
+      '07:00', '07:15', '07:30', '07:45',
+      '08:00', '08:15', '08:30', '08:45',
+      '09:00', '09:15', '09:30', '09:45',
+      '10:00', '10:15', '10:30', '10:45',
+      '11:00', '11:15', '11:30', '11:45',
+      '12:00', '12:15', '12:30', '12:45',
+      '13:00', '13:15', '13:30', '13:45',
+      '14:00', '14:15', '14:30', '14:45',
+      '15:00', '15:15', '15:30', '15:45',
+      '16:00', '16:15', '16:30', '16:45',
+      '17:00', '17:15', '17:30', '17:45',
+      '18:00', '18:15', '18:30', '18:45',
+      '19:00', '19:15', '19:30', '19:45',
+      '20:00', '20:15', '20:30', '20:45',
+      '21:00', '21:15', '21:30', '21:45',
+      '22:00', '22:15', '22:30', '22:45',
+      '23:00', '23:15', '23:30', '23:45'
+    ].freeze
 
     attr_reader :info
 
@@ -131,7 +157,7 @@ module HTCC
 
     def hold
       get_status
-      HOLD_TYPES[@status['latestData']['uiData']['StatusHeat']] # Both status are the same
+      HOLD_TYPES[@status['latestData']['uiData']['StatusHeat']] # Both statuses return the same value
     end
 
     def hold=(mode)
@@ -141,6 +167,20 @@ module HTCC
       change_setting(hold: mode)
     end
 
+    def hold_until
+      get_status
+      HOLD_TIMES[@status['latestData']['uiData']['HeatNextPeriod']] # Both periods return the same value
+    end
+
+    def hold_until=(time)
+      unless HOLD_TIMES.index(time)
+        raise HoldError.new(
+          "Unknown hold time: #{time.inspect}. Valid times are from 00:00 - 23:45 in 15 minute intervals."
+        )
+      end
+      change_setting(hold_until: time, hold: :temporary)
+    end
+
     def output_status
       get_status
       status = @status['latestData']['uiData']['EquipmentOutputStatus']
@@ -227,8 +267,7 @@ module HTCC
       system_mode: nil,
       heat_setpoint: nil,
       cool_setpoint: nil,
-      heat_next_period: nil,
-      cool_next_period: nil,
+      hold_until: nil,
       hold: nil,
       fan_mode: nil
     )
@@ -237,8 +276,8 @@ module HTCC
         'SystemSwitch':   SYSTEM_MODES.index(system_mode),
         'HeatSetpoint':   heat_setpoint,  
         'CoolSetpoint':   cool_setpoint,
-        'HeatNextPeriod': heat_next_period, # 0 = hold until 00:00, ..., 92 = hold until 23:45
-        'CoolNextPeriod': cool_next_period, # 0 = hold until 00:00, ..., 92 = hold until 23:45
+        'HeatNextPeriod': HOLD_TIMES.index(hold_until),
+        'CoolNextPeriod': HOLD_TIMES.index(hold_until),
         'StatusHeat':     HOLD_TYPES.index(hold),
         'StatusCool':     HOLD_TYPES.index(hold),
         'FanMode':        FAN_MODES.index(fan_mode)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: htcc
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Lee Folkman
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-29 00:00:00.000000000 Z
+date: 2021-03-30 00:00:00.000000000 Z
 dependencies: []
 description: This gem can be used to control Honeywell thermostats that use the Total
   Connect Comfort platform.