waterfurnace_aurora 0.7.7 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7af20433d8163a332a3d09c36b23af07b95d9beb088d4a0ce69436a54e46e434
-  data.tar.gz: 29a7c84feb1f58ecb6b0a44538f1a530add179ea95b0285f1739f172730b2d24
+  metadata.gz: 288c8dbc14788d26473f14dcfaf388f75c8aee92c2f3b4d388bfa8326cfd2842
+  data.tar.gz: c06f92936c81e402d08e01ae6b8c6c573acca46a85c9630914cb3c69f125a56a
 SHA512:
-  metadata.gz: 81c6604273350396388be239846997ee151f1b92ac47c270977e63347a5eeea81025eefece7d60cb3f2e374bca65816548bf3b8cc36bf249a1dbec57fbc0cb3a
-  data.tar.gz: 75ac82e3784f556b13274d5de4e64889023963286a3787e2521fef74ca5fb19ff0c49ea40a35fef7ea95bcae80b463ff84d15e67e4ddce098ffd69a3ead95843
+  metadata.gz: 5e64658afee912c8188af6d88bc98e208427b8dc4ef2ce1ea6ff1efcaca15ea2042ed4eef08ccfd764ec59ce0bb82013b0abd82173ec00f9ec61cbde07a66634
+  data.tar.gz: 6deff29644f83c329f1727d0a568c87536618ae63c7a27e58e4054eff187496c6f04bf3b63e2c35e649b2a0eb5b6395d81450a68b0096d1cacee9137c2f53c31

data/exe/aurora_mqtt_bridge

@@ -155,14 +155,16 @@ class MQTTBridge
                     hass: { sensor: { device_class: :temperature,
                                       state_class: :measurement,
                                       entity_category: :diagnostic } })
-      node.property("leaving-air-temperature",
-                    "Leaving Air Temperature",
-                    :float,
-                    @abc.leaving_air_temperature,
-                    unit: "°F",
-                    hass: { sensor: { device_class: :temperature,
-                                      state_class: :measurement,
-                                      entity_category: :diagnostic } })
+      if @abc.awl_communicating?
+        node.property("leaving-air-temperature",
+                      "Leaving Air Temperature",
+                      :float,
+                      @abc.leaving_air_temperature,
+                      unit: "°F",
+                      hass: { sensor: { device_class: :temperature,
+                                        state_class: :measurement,
+                                        entity_category: :diagnostic } })
+      end
       node.property("leaving-water-temperature",
                     "Leaving Water Temperature",
                     :float,
@@ -171,7 +173,8 @@ class MQTTBridge
                     hass: { sensor: { device_class: :temperature,
                                       state_class: :measurement,
                                       entity_category: :diagnostic } })
-      unless @abc.outdoor_temperature.zero? # TODO: figure out the config if this actually exists
+      # TODO: figure out the config if this actually exists
+      if @abc.awl_communicating? && !@abc.outdoor_temperature.zero?
         node.property("outdoor-temperature",
                       "Outdoor Temperature",
                       :float,
@@ -333,15 +336,6 @@ class MQTTBridge
                     :boolean,
                     @abc.pump.running,
                     hass: { binary_sensor: { device_class: :running } })
-      node.property("speed",
-                    "Speed",
-                    :integer,
-                    @abc.pump.speed,
-                    format: 0..100,
-                    unit: "%",
-                    hass: { number: { entity_category: :diagnostic } }) do |value, property|
-        @mutex.synchronize { property.value = @abc.pump.speed = value }
-      end
       node.property("manual-control",
                     "Manual Control",
                     :boolean,
@@ -367,6 +361,17 @@ class MQTTBridge
                     hass: { number: { entity_category: :config } }) do |value, property|
         @mutex.synchronize { property.value = @abc.pump.maximum_speed = value }
       end
+      next unless @abc.awl_axb?
+
+      node.property("speed",
+                    "Speed",
+                    :integer,
+                    @abc.pump.speed,
+                    format: 0..100,
+                    unit: "%",
+                    hass: { number: { entity_category: :diagnostic } }) do |value, property|
+        @mutex.synchronize { property.value = @abc.pump.speed = value }
+      end
     end
 
     if @abc.dhw
@@ -396,47 +401,41 @@ class MQTTBridge
                       @abc.dhw.set_point,
                       format: 100..140,
                       unit: "°F",
-                      hass: :number) do |value, property|
+                      hass: { number: { step: 5 } }) do |value, property|
           @mutex.synchronize { property.value = @abc.dhw.set_point = value }
         end
       end
     end
 
     @humidistat = @homie.node("humidistat", "Humidistat", "Humidistat") do |node|
-      node.property("relative-humidity",
-                    "Relative Humidity",
-                    :integer,
-                    @abc.humidistat.relative_humidity,
-                    unit: "%",
-                    format: 0..100,
-                    hass: { sensor: { device_class: :humidity,
-                                      state_class: :measurement } })
       if @abc.humidistat.humidifier?
         node.property("humidifier-running",
                       "Humidifier 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 }
+        if @abc.awl_communicating?
+          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
+          node.hass_humidifier("humidifier-running",
+                               target_property: "humidification-target",
+                               mode_property: "humidifier-mode",
+                               id: "humidifier",
+                               name: "Humidifier",
+                               device_class: :humidifier)
         end
-        node.hass_humidifier("humidifier-running",
-                             target_property: "humidification-target",
-                             mode_property: "humidifier-mode",
-                             id: "humidifier",
-                             name: "Humidifier",
-                             device_class: :humidifier)
       end
 
       # VSDrive can perform active dehumidification, even without a dedicated dehumidifier
@@ -446,28 +445,40 @@ class MQTTBridge
                       "Dehumidifier Running",
                       :boolean,
                       @abc.humidistat.dehumidifier_running?)
-        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 }
+        if @abc.awl_communicating?
+          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
+          node.hass_humidifier("dehumidifier-running",
+                               target_property: "dehumidification-target",
+                               mode_property: "dehumidifier-mode",
+                               id: "dehumidifier",
+                               name: "Dehumidifier",
+                               device_class: :dehumidifier)
         end
-        node.hass_humidifier("dehumidifier-running",
-                             target_property: "dehumidification-target",
-                             mode_property: "dehumidifier-mode",
-                             id: "dehumidifier",
-                             name: "Dehumidifier",
-                             device_class: :dehumidifier)
       end
+      next unless @abc.awl_communicating?
+
+      node.property("relative-humidity",
+                    "Relative Humidity",
+                    :integer,
+                    @abc.humidistat.relative_humidity,
+                    unit: "%",
+                    format: 0..100,
+                    hass: { sensor: { device_class: :humidity,
+                                      state_class: :measurement } })
     end
 
     @faults = @homie.node("faults", "Fault History", "ABC") do |node|
@@ -495,6 +506,14 @@ class MQTTBridge
     @abc.zones.each_with_index do |zone, i|
       type = zone.is_a?(Aurora::IZ2Zone) ? "IntelliZone 2 Zone" : "Thermostat"
       @homie.node("zone#{i + 1}", "Zone #{i + 1}", type) do |node|
+        node.property("current-mode",
+                      "Current Heating/Cooling Mode Requested",
+                      :enum,
+                      zone.current_mode,
+                      format: %w[standby h1 h2 h3 c1 c2])
+
+        next unless @abc.awl_communicating?
+
         allowed_modes = %w[off auto cool heat]
         allowed_modes << "eheat" if i.zero?
         node.property("target-mode",
@@ -504,11 +523,6 @@ class MQTTBridge
                       format: allowed_modes) do |value, property|
           @mutex.synchronize { property.value = zone.target_mode = value.to_sym }
         end
-        node.property("current-mode",
-                      "Current Heating/Cooling Mode Requested",
-                      :enum,
-                      zone.current_mode,
-                      format: %w[standby h1 h2 h3 c1 c2])
         node.property("target-fan-mode",
                       "Target Fan Mode",
                       :enum,

data/lib/aurora/abc_client.rb

@@ -86,6 +86,7 @@ module Aurora
     end
 
     attr_reader :modbus_slave,
+                :abc_version,
                 :model,
                 :serial_number,
                 :zones,
@@ -111,14 +112,15 @@ 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...110, 404, 412..413, 1103, 1114]
+      raw_registers = @modbus_slave.holding_registers[2, 33, 88...110, 404, 412..413, 813, 1103, 1114]
       registers = Aurora.transform_registers(raw_registers.dup)
+      @abc_version = registers[2]
       @program = registers[88]
       @model = registers[92]
       @serial_number = registers[105]
       @energy_monitor = raw_registers[412]
 
-      @zones = if iz2?
+      @zones = if iz2? && iz2_version >= 2.0
                  iz2_zone_count = @modbus_slave.holding_registers[483]
                  (0...iz2_zone_count).map { |i| IZ2Zone.new(self, i + 1) }
                else
@@ -152,8 +154,9 @@ module Aurora
 
       @faults = []
 
-      @registers_to_read = [6, 19..20, 25, 30, 112, 344, 740..741, 900, 1104, 1110..1111, 1114, 1150..1153, 1165,
-                            31_003]
+      @registers_to_read = [6, 19..20, 25, 30, 112, 344, 567, 1104, 1110..1111, 1114, 1150..1153, 1165]
+      @registers_to_read.concat([741, 31_003]) if awl_communicating?
+      @registers_to_read << 900 if awl_axb?
       zones.each do |z|
         @registers_to_read.concat(z.registers_to_read)
       end
@@ -178,8 +181,8 @@ module Aurora
 
       outputs = registers[30]
 
-      @entering_air_temperature   = registers[740]
-      @leaving_air_temperature    = registers[900]
+      @entering_air_temperature   = registers[567]
+      @leaving_air_temperature    = registers[900] if awl_axb?
       @leaving_water_temperature  = registers[1110]
       @entering_water_temperature = registers[1111]
       @outdoor_temperature        = registers[31_003]
@@ -270,13 +273,18 @@ module Aurora
     end
 
     # config aurora system
-    { thermostat: 800, axb: 806, iz2: 812, aoc: 815, moc: 818, eev2: 824 }.each do |(component, register)|
+    { thermostat: 800, axb: 806, iz2: 812, aoc: 815, moc: 818, eev2: 824, awl: 827 }.each do |(component, register)|
       class_eval <<-RUBY, __FILE__, __LINE__ + 1
         def #{component}?
           return @#{component} if instance_variable_defined?(:@#{component})
           @#{component} = @modbus_slave.holding_registers[#{register}] != 3
         end
 
+        def #{component}_version
+          return @#{component}_version if instance_variable_defined?(:@#{component}_version)
+          @#{component}_version = @modbus_slave.holding_registers[#{register + 1}].to_f / 100
+        end
+
         def add_#{component}
           @modbus_slave.holding_registers[#{register}] = 2
         end
@@ -287,6 +295,27 @@ module Aurora
       RUBY
     end
 
+    # see https://www.waterfurnace.com/literature/symphony/ig2001ew.pdf
+    # is there a communicating system compliant with AWL?
+    def awl_communicating?
+      awl_thermostat? || awl_iz2?
+    end
+
+    # is the thermostat AWL compliant?
+    def awl_thermostat?
+      thermostat? && thermostat_version >= 3.0
+    end
+
+    # is the IZ2 AWL compliant?
+    def awl_iz2?
+      iz2? && iz2_version >= 2.0
+    end
+
+    # is the AXB AWL compliant?
+    def awl_axb?
+      axb? && axb_version >= 2.0
+    end
+
     def inspect
       "#<Aurora::ABCClient #{(instance_variables - [:@modbus_slave]).map do |iv|
                                "#{iv}=#{instance_variable_get(iv).inspect}"

data/lib/aurora/humidistat.rb

@@ -29,6 +29,8 @@ module Aurora
     alias_method :dehumidifier_running?, :dehumidifier_running
 
     def registers_to_read
+      return [] unless @abc.awl_communicating?
+
       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])

data/lib/aurora/mock_abc.rb

@@ -20,9 +20,14 @@ module Aurora
       if register.length == 1
         case register.first
         when Integer
+          missing_register(register.first) unless @registers.key?(register.first)
           @registers[register.first]
         when Range
-          @registers.values_at(*register.first.to_a)
+          registers = register.first.to_a
+          registers.each do |i|
+            missing_register(i) unless @registers.key?(i)
+          end
+          @registers.values_at(*registers)
         else
           raise ArgumentError, "Not implemented yet #{register.inspect}"
         end
@@ -35,6 +40,11 @@ module Aurora
       result = {}
       queries.each do |query|
         Array(query).each do |i|
+          unless @registers.key?(i)
+            missing_register(i)
+            next
+          end
+
           result[i] = @registers[i]
         end
       end
@@ -45,5 +55,11 @@ module Aurora
       @registers[addr] = value
     end
     alias_method :[]=, :write_holding_register
+
+    private
+
+    def missing_register(idx)
+      logger.warn("missing register #{idx}")
+    end
   end
 end

data/lib/aurora/pump.rb

@@ -31,7 +31,7 @@ module Aurora
       alias_method :manual_control?, :manual_control
 
       def registers_to_read
-        super + [321..325]
+        super + (@abc.awl_axb? ? [321..325] : [321..324])
       end
 
       def refresh(registers)
@@ -39,7 +39,7 @@ module Aurora
         @minimum_speed = registers[321]
         @maximum_speed = registers[322]
         @manual_control = registers[323] != :off
-        @speed = registers[325]
+        @speed = registers[325] if @abc.awl_axb?
       end
 
       def manual_control=(value)

data/lib/aurora/registers.rb

@@ -65,7 +65,7 @@ module Aurora
 
   def to_string(registers, idx, length)
     (idx...(idx + length)).map do |i|
-      raise ArgumentError, "Missing register #{i} for string starting at #{idx}" unless registers[i]
+      next "\ufffd" unless registers[i] # missing data? add unicode invalid character
 
       (registers[i] >> 8).chr + (registers[i] & 0xff).chr
     end.join.sub(/[ \0]+$/, "")
@@ -112,7 +112,7 @@ module Aurora
     53 => "Condensing Pressure Sensor", # Low condensing pressure (PD) or invalid (0 to 870 psi) Retry 10x.
     54 => "Low Supply Voltage", # Supply Voltage is <180 V (190V to reset) or powered off/on too quickly (<30 sec.).
     55 => "Out of Envelope", # Comp Operating out of envelope (P0) more than 90 sec. Retry 10x.
-    56 => "Drive Over Currnet", # Over current tripped by phase loss, earth fault, short circuit, low water flow, low air flow, or major drive fault. # rubocop:disable Layout/LineLength
+    56 => "Drive Over Current", # Over current tripped by phase loss, earth fault, short circuit, low water flow, low air flow, or major drive fault. # rubocop:disable Layout/LineLength
     57 => "Drive Over/Under Voltage", # DC Link Voltage to compressor is >450vdc or at minimum voltage (<185vdc).
     58 => "High Drive Temp", # Drive Temp has reached critical High Temp >239 F
     59 => "Internal Drive Error", # The MOC has encountered an internal fault or an internal error. Probably fatal.

data/lib/aurora/thermostat.rb

@@ -15,19 +15,23 @@ module Aurora
                 :fan_intermittent_off
 
     def registers_to_read
+      return [31] unless @abc.awl_thermostat?
+
       [31, 502, 745..746, 12_005..12_006]
     end
 
     def refresh(registers)
-      @ambient_temperature = registers[502]
-      @heating_target_temperature = registers[745]
-      @cooling_target_temperature = registers[746]
-      config1 = registers[12_005]
-      config2 = registers[12_006]
-      @target_fan_mode = config1[:fan]
-      @fan_intermittent_on = config1[:on_time]
-      @fan_intermittent_off = config1[:off_time]
-      @target_mode = config2[:mode]
+      if @abc.awl_thermostat?
+        @ambient_temperature = registers[502]
+        @heating_target_temperature = registers[745]
+        @cooling_target_temperature = registers[746]
+        config1 = registers[12_005]
+        config2 = registers[12_006]
+        @target_fan_mode = config1[:fan]
+        @fan_intermittent_on = config1[:on_time]
+        @fan_intermittent_off = config1[:off_time]
+        @target_mode = config2[:mode]
+      end
 
       inputs = registers[31]
       @current_fan_mode = inputs.include?(:g)

data/lib/aurora/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: waterfurnace_aurora
 version: !ruby/object:Gem::Version
-  version: 0.7.7
+  version: 0.8.0
 platform: ruby
 authors:
 - Cody Cutrer