waterfurnace_aurora 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a372b51d3240840ae96269020f73728fb049f3e6c0438613c9659d4158d21aa6
-  data.tar.gz: 249e26d5764a0ab670a60b5de7ed6da0796344fd71896c6c33d353fc4a7d95ed
+  metadata.gz: 77762dc2957715e4f0a1dc4f608158b5f17a4801624f50d8af01ba26c8dc7410
+  data.tar.gz: 338fd829fb1bb364900242d2a4cdacada3e08a3b87214377f81f04b0c5f9eb66
 SHA512:
-  metadata.gz: c5c5ef5a5e1d6ec3d393913ca1b717a5a53a5f17c51f2c9b8ea0f6aeb627cdc873fa25e22511a779d7b9c0e9a60fdc21bc63dbb1fb0d8f6baa41c3dada85cb91
-  data.tar.gz: ee787175c344db12fe11f0dab4131505e5692ca360adeee78bcd0931bd4b28660de9c0d09817c5f30632808b374a3695f8a8cbf9f1e965bf410648f411ffa958
+  metadata.gz: 1a16b1f69d3b5720bdc323ae27b7de9908573e6a959857dce575273129fcfa5a42e7754ea87a072d28afbc47aa5e8ec9e46b40682fcc9a88dca30c36ec2aa207
+  data.tar.gz: 0d221ae7e69561ab79dd0f9591751492c4282dc4fd33a658cc8bf99ee6973587616f199c6228e7ca2506eb99fb7a622bc77a33d0272cea942ff99177dae22c90

data/exe/aurora_mqtt_bridge

@@ -92,7 +92,7 @@ class MQTTBridge
                          @blower => @abc.blower,
                          @pump => @abc.pump,
                          @dhw => @abc.dhw,
-                         @humidifier => @abc.humidifier }.compact
+                         @humidistat => @abc.humidistat }.compact
           @abc.zones.each_with_index do |z, idx|
             homie_zone = @homie["zone#{idx + 1}"]
             components[homie_zone] = z
@@ -105,6 +105,8 @@ class MQTTBridge
           end
 
           @abc.faults.each_with_index do |fault_count, i|
+            next if fault_count == 0xffff
+
             @faults["e#{i + 1}"].value = fault_count
           end
         end
@@ -118,8 +120,10 @@ class MQTTBridge
 
   def publish_basic_attributes
     @homie_abc = @homie.node("abc", "Aurora Basic Control", "ABC") do |node|
+      allowed_modes = %w[lockout standby blower heating cooling eh1 eh2 emergency waiting]
+      allowed_modes << "dehumidify" if @abc.compressor.is_a?(Aurora::Compressor::VSDrive)
       node.property("current-mode", "Current Heating/Cooling Mode", :enum, @abc.current_mode,
-                    format: %w[lockout standby blower heating cooling eh1 eh2 emergency waiting dehumidify])
+                    format: allowed_modes)
       node.property("entering-air-temperature", "Entering Air Temperature", :float, @abc.entering_air_temperature,
                     unit: "ºF")
       node.property("entering-water-temperature", "Entering Water Temperature", :float,
@@ -131,8 +135,7 @@ class MQTTBridge
       unless @abc.outdoor_temperature.zero? # TODO: figure out the config if this actually exists
         node.property("outdoor-temperature", "Outdoor Temperature", :float, @abc.outdoor_temperature, unit: "ºF")
       end
-      node.property("relative-humidity", "Relative Humidity", :integer, @abc.relative_humidity, unit: "%",
-                                                                                                format: 0..100)
+
       node.property("fp1", "FP1 Sensor", :float, @abc.fp1, unit: "ºF")
       node.property("fp2", "FP2 Sensor", :float, @abc.fp2, unit: "ºF")
       %i[aux_heat total].each do |component|
@@ -190,6 +193,7 @@ class MQTTBridge
 
       next unless @abc.pump.is_a?(Aurora::Pump::VSPump)
 
+      node.property("running", "Pump is running", :boolean, @abc.pump.running)
       node.property("speed", "Speed", :integer, @abc.pump.speed, format: 0..100, unit: "%") do |value, property|
         @mutex.synchronize { property.value = @abc.pump.speed = value }
       end
@@ -212,6 +216,7 @@ class MQTTBridge
         node.property("enabled", "Enabled", :boolean, @abc.dhw.enabled) do |value, property|
           @mutex.synchronize { property.value = @abc.dhw.enabled = value }
         end
+        node.property("running", "DHW Pump is running", :boolean, @abc.dhw.running?)
         node.property("water-temperature", "Water Temperature", :float,
                       @abc.dhw.water_temperature, unit: "ºF")
         node.property("set-point", "Set Point", :float, @abc.dhw.set_point, format: 100..140,
@@ -221,10 +226,36 @@ class MQTTBridge
       end
     end
 
-    if @abc.humidifier
-      @humidifier = @homie.node("humidifier", "Humidifier", "Humidifier") do |node|
-        node.property("running", "Humidifier is running", :boolean, @abc.humidifier.running?)
+    @humidistat = @homie.node("humidistat", "Humidistat", "Humidistat") do |node|
+      node.property("relative-humidity", "Relative Humidity", :integer, @abc.humidistat.relative_humidity,
+         unit: "%", format: 0..100)
+      if @abc.humidistat.humidifier?
+        node.property("humidifier-running", "Humidifier is running", :boolean, @abc.humidistat.humidifier_running?)
+        node.property("humidifier-mode", "Humidifier Mode", :enum, @abc.humidistat.humidifier_mode,
+                      format: %i[auto manual]) do |value, property|
+          @mutex.synchronize { property.value = @abc.humidistat.humidifier_mode = value.to_sym }
+        end
+        node.property("humidification-target", "Humidification target relative humidity", :integer,
+                      @abc.humidistat.humidification_target, unit: "%", format: 15..50) do |value, property|
+          @mutex.synchronize { property.value = @abc.humidistat.humidification_target = value }
+        end
       end
+
+      # VSDrive can perform active dehumidification, even without a dedicated dehumidifier
+      if @abc.humidistat.dehumidifier? || @abc.compressor.is_a?(Aurora::Compressor::VSDrive)
+        node.property("dehumidifier-mode", "Dehumidifier Mode", :enum, @abc.humidistat.dehumidifier_mode,
+                      format: %i[auto manual]) do |value, property|
+          @mutex.synchronize { property.value = @abc.humidistat.dehumidifier_mode = value.to_sym }
+        end
+        node.property("dehumidification-target", "Dehumidification target relative humidity", :integer,
+                      @abc.humidistat.dehumidification_target, unit: "%", format: 35..65) do |value, property|
+          @mutex.synchronize { property.value = @abc.humidistat.dehumidification_target = value }
+        end
+      end
+
+      next unless @abc.humidistat.dehumidifier?
+
+      node.property("dehumidifier-running", "Dehumidifier is running", :boolean, @abc.humidistat.dehumidifier_running?)
     end
 
     @faults = @homie.node("faults", "Fault History", "ABC") do |node|
@@ -232,6 +263,8 @@ class MQTTBridge
         @mutex.synchronize { @abc.clear_fault_history }
       end
       @abc.faults.each_with_index do |count, i|
+        next if count == 0xffff
+
         name = Aurora::FAULTS[i + 1]
         node.property("e#{i + 1}", name || "E#{i + 1}", :integer, count)
       end

data/lib/aurora/abc_client.rb

@@ -6,7 +6,7 @@ require "uri"
 require "aurora/blower"
 require "aurora/compressor"
 require "aurora/dhw"
-require "aurora/humidifier"
+require "aurora/humidistat"
 require "aurora/iz2_zone"
 require "aurora/pump"
 require "aurora/thermostat"
@@ -49,11 +49,10 @@ module Aurora
                 :blower,
                 :pump,
                 :dhw,
-                :humidifier,
+                :humidistat,
                 :faults,
                 :current_mode,
                 :entering_air_temperature,
-                :relative_humidity,
                 :leaving_air_temperature,
                 :leaving_water_temperature,
                 :entering_water_temperature,
@@ -67,7 +66,7 @@ module Aurora
       @modbus_slave = self.class.open_modbus_slave(uri)
       @modbus_slave.read_retry_timeout = 15
       @modbus_slave.read_retries = 2
-      raw_registers = @modbus_slave.holding_registers[33, 88..91, 105...110, 404, 412..413, 1114]
+      raw_registers = @modbus_slave.holding_registers[33, 88..91, 105...110, 404, 412..413, 1103, 1114]
       registers = Aurora.transform_registers(raw_registers.dup)
       @program = registers[88]
       @serial_number = registers[105]
@@ -81,6 +80,7 @@ module Aurora
                end
 
       @abc_dipswitches = registers[33]
+      @axb_dipswitches = registers[1103]
       @compressor = if @program == "ABCVSP"
                       Compressor::VSDrive.new(self)
                     else
@@ -100,9 +100,23 @@ module Aurora
                                       registers[413])
               end
       @dhw = DHW.new(self) if (-999..999).include?(registers[1114])
-      @humidifier = Humidifier.new(self) if @abc_dipswitches[:accessory_relay] == :humidifier
+      @humidistat = Humidistat.new(self,
+                                   @abc_dipswitches[:accessory_relay] == :humidifier,
+                                   @axb_dipswitches[:accessory_relay2] == :dehumidifier)
 
       @faults = []
+
+      @registers_to_read = [6, 19..20, 25, 30, 344, 740..741, 900, 1104, 1110..1111, 1114, 1150..1153, 1165,
+                            31_003]
+      zones.each do |z|
+        @registers_to_read.concat(z.registers_to_read)
+      end
+      @components = [compressor, blower, pump, dhw, humidistat].compact
+      @components.each do |component|
+        @registers_to_read.concat(component.registers_to_read)
+      end
+      # need dehumidify mode to calculate final current mode
+      @registers_to_read.concat([362]) if compressor.is_a?(Compressor::VSDrive)
     end
 
     def query_registers(query)
@@ -140,29 +154,15 @@ module Aurora
     end
 
     def refresh
-      registers_to_read = [6, 19..20, 25, 30, 344, 740..741, 900, 1110..1111, 1114, 1150..1153, 1165,
-                           31_003]
-      zones.each do |z|
-        registers_to_read.concat(z.registers_to_read)
-      end
-      registers_to_read.concat(compressor.registers_to_read)
-      registers_to_read.concat(blower.registers_to_read)
-      registers_to_read.concat(pump.registers_to_read)
-      registers_to_read.concat(dhw.registers_to_read) if dhw
-      # need dehumidify mode to calculate final current mode;
-      # apparently non-VSD doesn't have this register at all?
-      registers_to_read.concat([362]) if compressor.is_a?(Compressor::VSDrive)
-
       faults = @modbus_slave.read_multiple_holding_registers(601..699)
       @faults = Aurora.transform_registers(faults).values
 
-      registers = @modbus_slave.holding_registers[*registers_to_read]
+      registers = @modbus_slave.holding_registers[*@registers_to_read]
       Aurora.transform_registers(registers)
 
       outputs = registers[30]
 
       @entering_air_temperature   = registers[740]
-      @relative_humidity          = registers[741]
       @leaving_air_temperature    = registers[900]
       @leaving_water_temperature  = registers[1110]
       @entering_water_temperature = registers[1111]
@@ -197,11 +197,9 @@ module Aurora
       zones.each do |z|
         z.refresh(registers)
       end
-      compressor.refresh(registers)
-      blower.refresh(registers)
-      pump.refresh(registers)
-      dhw&.refresh(registers)
-      humidifier&.refresh(registers)
+      @components.each do |component|
+        component.refresh(registers)
+      end
     end
 
     def cooling_airflow_adjustment=(value)

data/lib/aurora/dhw.rb

@@ -4,7 +4,8 @@ require "aurora/component"
 
 module Aurora
   class DHW < Component
-    attr_reader :enabled, :set_point, :water_temperature
+    attr_reader :enabled, :running, :set_point, :water_temperature
+    alias running? running
 
     def registers_to_read
       [400..401, 1114]
@@ -12,6 +13,7 @@ module Aurora
 
     def refresh(registers)
       @enabled = registers[400]
+      @running = registers[1104].include?(:dhw)
       @set_point = registers[401]
       @water_temperature = registers[1114]
     end

data/lib/aurora/humidistat.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require "aurora/component"
+
+module Aurora
+  class Humidistat < Component
+    attr_reader :humidifier_running, :humidifier_mode, :humidification_target,
+                :dehumidifier_running, :dehumidifier_mode, :dehumidification_target,
+                :relative_humidity
+    alias humidifier_running? humidifier_running
+    alias dehumidifer_running? dehumidifier_running
+
+    def initialize(abc, has_humidifier, has_dehumidifier)
+      super(abc)
+      @humidifier = has_humidifier
+      @dehumidifier = has_dehumidifier
+    end
+
+    def humidifier?
+      @humidifier
+    end
+
+    def dehumidifier?
+      @dehumidifier
+    end
+
+    def registers_to_read
+      result = [741]
+      if humidifier? || dehumidifier? || abc.compressor.is_a?(Compressor::VSDrive)
+        result.concat(abc.iz2? ? [21_114, 31_109..31_110] : [12_309..12_310])
+      end
+      result
+    end
+
+    def refresh(registers)
+      @relative_humidity = registers[741]
+
+      outputs = registers[30]
+      @humidifier_running = humidifier? && outputs.include?(:accessory)
+
+      outputs = registers[1104]
+      @dehumidifer_running = dehumidifier? && outputs.include?(:accessory2)
+
+      base = abc.iz2? ? 31_109 : 12_309
+      @humidifier_settings = registers[abc.iz2? ? 21_114 : 12_309]
+      @humidifier_mode = @humidifier_settings&.include?(:auto_humidification) ? :auto : :manual
+      @dehumidifier_mode = @humidifier_settings&.include?(:auto_dehumidification) ? :auto : :manual
+
+      @humidification_target = registers[base + 1]&.[](:humidification_target)
+      @dehumidification_target = registers[base + 1]&.[](:dehumidification_target)
+    end
+
+    def humidifier_mode=(mode)
+      set_humidistat_mode(mode, dehumidifier_mode)
+    end
+
+    def dehumidifier_mode=(mode)
+      set_humidistat_mode(humidifier_mode, mode)
+    end
+
+    def set_humidistat_mode(humidifier_mode, dehumidifier_mode)
+      allowed = %i[auto manual]
+      raise ArgumentError unless allowed.include?(humidifier_mode) && allowed.include?(dehumidifier_mode)
+
+      # start with the prior value of the register, since I'm not sure what
+      # else is stuffed in there
+      raw_value = @humidifier_settings &= ~0xc000
+      raw_value |= 0x4000 if humidifier_mode == :auto
+      raw_value |= 0x8000 if dehumidifier_mode == :auto
+      holding_registers[abc.iz2? ? 21_114 : 12_309] = raw_value
+      @humidifier_mode = humidifier_mode
+      @dehumidifier_mode = dehumidifier_mode
+    end
+
+    def humidification_target=(value)
+      set_humidistat_targets(value, dehumidification_target)
+    end
+
+    def dehumidification_target=(value)
+      set_humidistat_targets(humidification_target, value)
+    end
+
+    def set_humidistat_targets(humidification_target, dehumidification_target)
+      raise ArgumentError unless (15..50).include?(humidification_target)
+      raise ArgumentError unless (35..65).include?(dehumidification_target)
+
+      holding_registers[iz2? ? 21_115 : 12_310] = (humidification_target << 8) + dehumidification_target
+      @humidification_target = humidification_target
+      @dehumidification_target = dehumidification_target
+    end
+  end
+end

data/lib/aurora/pump.rb

@@ -5,7 +5,8 @@ require "aurora/component"
 module Aurora
   module Pump
     class GenericPump < Component
-      attr_reader :type, :watts, :waterflow
+      attr_reader :type, :watts, :waterflow, :running
+      alias running? running
 
       def initialize(abc, type)
         super(abc)
@@ -21,6 +22,7 @@ module Aurora
       def refresh(registers)
         @waterflow = registers[1117]
         @watts = registers[1164] if abc.energy_monitoring?
+        @running = registers[1104].include?(:loop_pump)
       end
     end
 

data/lib/aurora/registers.rb

@@ -302,23 +302,23 @@ module Aurora
 
   def axb_inputs(value)
     result = {}
-    result["Smart Grid"] = value & 0x001 == 0x001
-    result["Home Automation 1"] = value & 0x002 == 0x002
-    result["Home Automation 2"] = value & 0x004 == 0x004
-    result["Pump Slave"] = value & 0x008 == 0x008
+    result[:smart_grid] = value & 0x001 == 0x001
+    result[:ha1] = value & 0x002 == 0x002
+    result[:ha2] = value & 0x004 == 0x004
+    result[:pump_slave] = value & 0x008 == 0x008
 
     result[:mb_address] = value & 0x010 == 0x010 ? 3 : 4
     result[:sw1_2] = value & 0x020 == 0x020 # future use # rubocop:disable Naming/VariableNumber
     result[:sw1_3] = value & 0x040 == 0x040 # future use # rubocop:disable Naming/VariableNumber
-    result[:cycle_with] = if value & 0x080 == 0x080 && value & 0x100 == 0x100
-                            "Blower"
-                          elsif value & 0x100 == 0x100
-                            "Low Capacity Compressor"
-                          elsif value & 0x080 == 0x080
-                            "High Capacity Compressor"
-                          else
-                            "Thermostat Dehumidifier"
-                          end
+    result[:accessory_relay2] = if value & 0x080 == 0x080 && value & 0x100 == 0x100
+                                  :blower
+                                elsif value & 0x100 == 0x100
+                                  :low_capacity_compressor
+                                elsif value & 0x080 == 0x080
+                                  :high_capacity_compressor
+                                else
+                                  :dehumidifier
+                                end
     leftover = value & ~0x1ff
     result[:unknown] = format("0x%04x", leftover) unless leftover.zero?
     result
@@ -523,7 +523,6 @@ module Aurora
     ->(v) { PUMP_TYPE[v] } => [413],
     ->(v) { PHASE_TYPE[v] } => [416],
     method(:iz2_fan_desired) => [565],
-    ->(v) { v == 0xffff ? 0 : v } => 601..699,
     ->(registers, idx) { to_string(registers, idx, 8) } => [710],
     ->(v) { COMPONENT_STATUS[v] } => [800, 803, 806, 812, 815, 818, 824, 827],
     method(:axb_inputs) => [1103],
@@ -534,8 +533,8 @@ module Aurora
     method(:thermostat_configuration2) => [12_006],
     ->(v) { HEATING_MODE[v] } => [12_606, 21_202, 21_211, 21_220, 21_229, 21_238, 21_247],
     ->(v) { FAN_MODE[v] } => [12_621, 21_205, 21_214, 21_223, 21_232, 21_241, 21_250],
-    ->(v) { from_bitmask(v, HUMIDIFIER_SETTINGS) } => [31_109],
-    ->(v) { { humidification_target: v >> 8, dehumidification_target: v & 0xff } } => [31_110],
+    ->(v) { from_bitmask(v, HUMIDIFIER_SETTINGS) } => [12_309, 21_114, 31_109],
+    ->(v) { { humidification_target: v >> 8, dehumidification_target: v & 0xff } } => [12_310, 21_115, 31_110],
     method(:iz2_demand) => [31_005],
     method(:zone_configuration1) => [12_005, 31_008, 31_011, 31_014, 31_017, 31_020, 31_023],
     method(:zone_configuration2) => [31_009, 31_012, 31_015, 31_018, 31_021, 31_024],
@@ -889,16 +888,20 @@ module Aurora
     3906 => "VS Drive SuperHeat Temperature",
     12_005 => "Fan Configuration",
     12_006 => "Heating Mode",
+    12_309 => "De/Humidifier Mode",
+    12_310 => "De/Humidifier Setpoints",
     12_606 => "Heating Mode (write)",
     12_619 => "Heating Setpoint (write)",
     12_620 => "Cooling Setpoint (write)",
     12_621 => "Fan Mode (write)",
     12_622 => "Intermittent Fan On Time (write)",
     12_623 => "Intermittent Fan Off Time (write)",
+    21_114 => "IZ2 De/Humidifier Mode (write)",
+    21_115 => "IZ2 De/Humidifier Setpoints (write)",
     31_003 => "Outdoor Temp",
     31_005 => "IZ2 Demand",
-    31_109 => "Humidifier Mode", # write to 21114
-    31_110 => "Manual De/Humidification Target", # write to 21115
+    31_109 => "De/Humidifier Mode",
+    31_110 => "Manual De/Humidification Setpoints",
     31_400 => "Dealer Name",
     31_413 => "Dealer Phone",
     31_421 => "Dealer Address 1",

data/lib/aurora/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Aurora
-  VERSION = "0.5.3"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: waterfurnace_aurora
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Cody Cutrer
@@ -139,7 +139,7 @@ files:
 - lib/aurora/compressor.rb
 - lib/aurora/core_ext/string.rb
 - lib/aurora/dhw.rb
-- lib/aurora/humidifier.rb
+- lib/aurora/humidistat.rb
 - lib/aurora/iz2_zone.rb
 - lib/aurora/mock_abc.rb
 - lib/aurora/modbus/server.rb

data/lib/aurora/humidifier.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require "aurora/component"
-
-module Aurora
-  class Humidifier < Component
-    attr_reader :running
-    alias running? running
-
-    def refresh(registers)
-      outputs = registers[30]
-      @running = outputs.include?(:accessory)
-    end
-  end
-end