waterfurnace_aurora 0.7.6 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6682276ad275ed03cc9985a993fb2b97830d4aee801d544797b7dbe4e34288db
-  data.tar.gz: 674d421a8729c071bab6de126757d993eb4940a0ee6e514b8e689397ceee1c56
+  metadata.gz: 8311d85ee1e300bcfbb3228a65cb98a69301f25f27569c36d898faf97c25fbd5
+  data.tar.gz: 86eab096d17d12aa01bb56f253022d64bb806d5aec3b55c6efc16a895b75d111
 SHA512:
-  metadata.gz: a47a7971f42f9ad100cc756b06b6146fc2c315a4298af501478f7208697d31bbd535ee26e7cd1250f4391bb7df16cd07da5ea420e752cfb95d6c4e1192ae9021
-  data.tar.gz: 2fdd41be490e09ae5436508b972134ee3f51c2b07b24f21006fccec51fd9981a79715a380ef401ad76a5c5680cf329b023b8f2e2f3a53cf3b8f2a78c08a71c73
+  metadata.gz: 7edd9fd909c0b9fe316f306bf00a56eff1108f467718d71c1645596675938abd67c5e727b4f6312d79c1d706df0f22f7d65f475c35061f7b66405add92eec342
+  data.tar.gz: b0a6f4af036ebcd003557777e1fd276e33e56e1cbfbde268ad42a5a5bfa729c9ffa718dd3fd08917aad8beba2bf4d894519de128a5ba1519b5988ba5ddc707f7

data/exe/aurora_mqtt_bridge

@@ -93,6 +93,7 @@ class MQTTBridge
           @abc.refresh
 
           components = { @homie_abc => @abc,
+                         @aux_heat => @abc.aux_heat,
                          @compressor => @abc.compressor,
                          @blower => @abc.blower,
                          @pump => @abc.pump,
@@ -131,7 +132,7 @@ class MQTTBridge
     }
 
     @homie_abc = @homie.node("abc", "Heat Pump", "ABC") do |node|
-      allowed_modes = %w[lockout standby blower heating cooling eh1 eh2 emergency waiting]
+      allowed_modes = %w[lockout standby blower heating heating_with_aux emergency_heat cooling waiting]
       allowed_modes << "dehumidify" if @abc.compressor.is_a?(Aurora::Compressor::VSDrive)
       node.property("current-mode",
                     "Current Heating/Cooling Mode",
@@ -155,14 +156,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 +174,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,
@@ -186,8 +190,8 @@ class MQTTBridge
                     :integer,
                     @abc.line_voltage,
                     format: 90..635,
-                    unit: "V") do |value, property|
-                      @mutex.synchronize { property.value = @abc.line_voltage = value }
+                    unit: "V") do |value|
+                      @mutex.synchronize { @abc.line_voltage = value }
                     end
       node.property("fp1",
                     "FP1 Sensor",
@@ -205,12 +209,11 @@ class MQTTBridge
                     hass: { sensor: { device_class: :temperature,
                                       state_class: :measurement,
                                       entity_category: :diagnostic } })
-      %i[aux_heat total].each do |component|
-        component = "#{component}_watts"
-        node.property(component.tr("_", "-"),
-                      component.sub("_watts", " Power Usage").tr("_", " ").titleize,
+      if @abc.energy_monitoring?
+        node.property("watts",
+                      "Total Power Usage",
                       :integer,
-                      @abc.public_send(component),
+                      @abc.watts,
                       unit: "W",
                       hass: { sensor: { device_class: :power,
                                         state_class: :measurement } })
@@ -244,6 +247,30 @@ class MQTTBridge
                     hass: { sensor: { device_class: :temperature,
                                       state_class: :measurement,
                                       entity_category: :diagnostic } })
+      node.property("drive-temperature",
+                    "Drive Temperature",
+                    :float,
+                    @abc.compressor.drive_temperature,
+                    unit: "°F",
+                    hass: { sensor: { device_class: :temperature,
+                                      state_class: :measurement,
+                                      entity_category: :diagnostic } })
+      node.property("inverter-temperature",
+                    "Inverter Temperature",
+                    :float,
+                    @abc.compressor.inverter_temperature,
+                    unit: "°F",
+                    hass: { sensor: { device_class: :temperature,
+                                      state_class: :measurement,
+                                      entity_category: :diagnostic } })
+      node.property("fan-speed",
+                    "Fan Speed",
+                    :integer,
+                    @abc.compressor.fan_speed,
+                    unit: "%",
+                    format: 0..100,
+                    hass: { sensor: { state_class: :measurement,
+                                      entity_category: :diagnostic } })
 
       next unless @abc.iz2?
 
@@ -256,6 +283,25 @@ class MQTTBridge
                                       entity_category: :diagnostic } })
     end
 
+    @aux_heat = @homie.node("aux-heat", "Aux Heater", "Aux Heater") do |node|
+      node.property("stage",
+                    "Current Stage",
+                    :integer,
+                    @abc.aux_heat.stage,
+                    format: 0..2,
+                    hass: { sensor: { state_class: :measurement } })
+
+      if @abc.energy_monitoring?
+        node.property("watts",
+                      "Power Usage",
+                      :integer,
+                      @abc.aux_heat.watts,
+                      unit: "W",
+                      hass: { sensor: { device_class: :power,
+                                        state_class: :measurement } })
+      end
+    end
+
     @blower = @homie.node("blower", "Blower", @abc.blower.type) do |node|
       node.property("running",
                     "Running",
@@ -291,8 +337,8 @@ class MQTTBridge
                       :integer,
                       @abc.blower.public_send(field),
                       format: 1..12,
-                      hass: { number: { entity_category: :config } }) do |value, property|
-          @mutex.synchronize { property.value = @abc.blower.public_send("#{field}=", value) }
+                      hass: { number: { entity_category: :config } }) do |value|
+          @mutex.synchronize { @abc.blower.public_send("#{field}=", value) }
         end
       end
 
@@ -333,21 +379,12 @@ 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,
                     @abc.pump.manual_control?,
-                    hass: { switch: { entity_category: :diagnostic } }) do |value, property|
-        @mutex.synchronize { property.value = @abc.pump.manual_control = value }
+                    hass: { switch: { entity_category: :diagnostic } }) do |value|
+        @mutex.synchronize { @abc.pump.manual_control = value }
       end
       node.property("minimum-speed",
                     "Actual Minimum Speed",
@@ -355,8 +392,8 @@ class MQTTBridge
                     @abc.pump.minimum_speed,
                     format: 0..100,
                     unit: "%",
-                    hass: { number: { entity_category: :config } }) do |value, property|
-        @mutex.synchronize { property.value = @abc.pump.minimum_speed = value }
+                    hass: { number: { entity_category: :config } }) do |value|
+        @mutex.synchronize { @abc.pump.minimum_speed = value }
       end
       node.property("maximum-speed",
                     "Actual Maximum Speed",
@@ -364,8 +401,19 @@ class MQTTBridge
                     @abc.pump.minimum_speed,
                     format: 0..100,
                     unit: "%",
-                    hass: { number: { entity_category: :config } }) do |value, property|
-        @mutex.synchronize { property.value = @abc.pump.maximum_speed = value }
+                    hass: { number: { entity_category: :config } }) do |value|
+        @mutex.synchronize { @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|
+        @mutex.synchronize { @abc.pump.speed = value }
       end
     end
 
@@ -375,8 +423,8 @@ class MQTTBridge
                       "Enabled",
                       :boolean,
                       @abc.dhw.enabled,
-                      hass: { switch: { icon: "mdi:water-boiler" } }) do |value, property|
-          @mutex.synchronize { property.value = @abc.dhw.enabled = value }
+                      hass: { switch: { icon: "mdi:water-boiler" } }) do |value|
+          @mutex.synchronize { @abc.dhw.enabled = value }
         end
         node.property("running",
                       "Pump Running",
@@ -396,47 +444,41 @@ class MQTTBridge
                       @abc.dhw.set_point,
                       format: 100..140,
                       unit: "°F",
-                      hass: :number) do |value, property|
-          @mutex.synchronize { property.value = @abc.dhw.set_point = value }
+                      hass: { number: { step: 5 } }) do |value|
+          @mutex.synchronize { @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|
+            @mutex.synchronize { @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|
+            @mutex.synchronize { @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 +488,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|
+            @mutex.synchronize { @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|
+            @mutex.synchronize { @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,26 +549,29 @@ 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",
                       "Target Heating/Cooling Mode",
                       :enum,
                       zone.target_mode,
-                      format: allowed_modes) do |value, property|
-          @mutex.synchronize { property.value = zone.target_mode = value.to_sym }
+                      format: allowed_modes) do |value|
+          @mutex.synchronize { 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,
                       zone.target_fan_mode,
-                      format: %w[auto continuous intermittent]) do |value, property|
-          @mutex.synchronize { property.value = zone.target_fan_mode = value.to_sym }
+                      format: %w[auto continuous intermittent]) do |value|
+          @mutex.synchronize { zone.target_fan_mode = value.to_sym }
         end
         node.property("fan-intermittent-on",
                       "Fan Intermittent Mode On Duration",
@@ -522,8 +579,8 @@ class MQTTBridge
                       zone.fan_intermittent_on,
                       unit: "M",
                       format: %w[0 5 10 15 20],
-                      hass: { select: { entity_category: :config } }) do |value, property|
-          @mutex.synchronize { property.value = zone.fan_intermittent_on = value.to_i }
+                      hass: { select: { entity_category: :config } }) do |value|
+          @mutex.synchronize { zone.fan_intermittent_on = value.to_i }
         end
         node.property("fan-intermittent-off",
                       "Fan Intermittent Mode Off Duration",
@@ -531,8 +588,8 @@ class MQTTBridge
                       zone.fan_intermittent_on,
                       unit: "M",
                       format: %w[0 5 10 15 20 25 30 35 40],
-                      hass: { select: { entity_category: :config } }) do |value, property|
-          @mutex.synchronize { property.value = zone.fan_intermittent_on = value.to_i }
+                      hass: { select: { entity_category: :config } }) do |value|
+          @mutex.synchronize { zone.fan_intermittent_on = value.to_i }
         end
         node.property("current-fan-mode",
                       "Current Fan Status",
@@ -573,15 +630,15 @@ class MQTTBridge
                       :integer,
                       zone.heating_target_temperature,
                       unit: "°F",
-                      format: 40..90) do |value, property|
-          @mutex.synchronize { property.value = zone.heating_target_temperature = value }
+                      format: 40..90) do |value|
+          @mutex.synchronize { zone.heating_target_temperature = value }
         end
         node.property("cooling-target-temperature",
                       "Cooling Target Temperature", :integer,
                       zone.cooling_target_temperature,
                       unit: "°F",
-                      format: 54..99) do |value, property|
-          @mutex.synchronize { property.value = zone.cooling_target_temperature = value }
+                      format: 54..99) do |value|
+          @mutex.synchronize { zone.cooling_target_temperature = value }
         end
         node.hass_climate(action_property: "current-mode",
                           current_temperature_property: "ambient-temperature",

data/lib/aurora/abc_client.rb

@@ -3,6 +3,7 @@
 require "yaml"
 require "uri"
 
+require "aurora/aux_heat"
 require "aurora/blower"
 require "aurora/compressor"
 require "aurora/dhw"
@@ -63,20 +64,20 @@ module Aurora
         registers = {}
         queries.each do |subquery|
           registers.merge!(modbus_slave.read_multiple_holding_registers(*subquery))
-        rescue ::ModBus::Errors::IllegalDataAddress
+        rescue ::ModBus::Errors::IllegalDataAddress, ::ModBus::Errors::IllegalFunction
           # maybe this unit doesn't respond to all the addresses we want?
           raise unless implicit
 
           # try each query individually
           subquery.each do |subsubquery|
             registers.merge!(modbus_slave.read_multiple_holding_registers(subsubquery))
-          rescue ::ModBus::Errors::IllegalDataAddress
+          rescue ::ModBus::Errors::IllegalDataAddress, ::ModBus::Errors::IllegalFunction
             next unless try_individual
 
             # seriously?? try each register individually
             subsubquery.each do |i|
               registers[i] = modbus_slave.holding_registers[i]
-            rescue ::ModBus::Errors::IllegalDataAddress
+            rescue ::ModBus::Errors::IllegalDataAddress, ::ModBus::Errors::IllegalFunction
               next
             end
           end
@@ -86,9 +87,11 @@ module Aurora
     end
 
     attr_reader :modbus_slave,
+                :abc_version,
                 :model,
                 :serial_number,
                 :zones,
+                :aux_heat,
                 :compressor,
                 :blower,
                 :pump,
@@ -104,21 +107,21 @@ module Aurora
                 :fp1,
                 :fp2,
                 :line_voltage,
-                :aux_heat_watts,
-                :total_watts
+                :watts
 
     def initialize(uri)
       @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
@@ -127,6 +130,7 @@ module Aurora
 
       @abc_dipswitches = registers[33]
       @axb_dipswitches = registers[1103]
+      @aux_heat = AuxHeat.new(self)
       @compressor = if @program == "ABCVSP"
                       Compressor::VSDrive.new(self)
                     else
@@ -152,12 +156,13 @@ 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
-      @components = [compressor, blower, pump, dhw, humidistat].compact
+      @components = [aux_heat, compressor, blower, pump, dhw, humidistat].compact
       @components.each do |component|
         @registers_to_read.concat(component.registers_to_read)
       end
@@ -178,8 +183,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]
@@ -190,22 +195,25 @@ module Aurora
       @derated                    = (41..46).cover?(@error)
       @safe_mode                  = [47, 48, 49, 72, 74].include?(@error)
       @line_voltage               = registers[112]
-      @aux_heat_watts             = registers[1151]
-      @total_watts                = registers[1153]
+      @watts                      = registers[1153]
 
       @current_mode = if outputs.include?(:lockout)
                         :lockout
                       elsif registers[362]
                         :dehumidify
                       elsif outputs.include?(:cc2) || outputs.include?(:cc)
-                        outputs.include?(:rv) ? :cooling : :heating
-                      elsif outputs.include?(:eh2)
-                        outputs.include?(:rv) ? :eh2 : :emergency
-                      elsif outputs.include?(:eh1)
-                        outputs.include?(:rv) ? :eh1 : :emergency
+                        if outputs.include?(:rv)
+                          :cooling
+                        elsif outputs.include?(:eh2) || outputs.include?(:eh1)
+                          :heating_with_aux
+                        else
+                          :heating
+                        end
+                      elsif outputs.include?(:eh2) || outputs.include?(:eh1)
+                        :emergency_heat
                       elsif outputs.include?(:blower)
                         :blower
-                      elsif registers[6]
+                      elsif !registers[6].zero?
                         :waiting
                       else
                         :standby
@@ -270,13 +278,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 +300,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/aux_heat.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "aurora/component"
+
+module Aurora
+  class AuxHeat < Component
+    attr_reader :stage, :watts
+
+    def refresh(registers)
+      outputs = registers[30]
+      @stage = if outputs.include?(:eh2)
+                 2
+               elsif outputs.include?(:eh1)
+                 1
+               else
+                 0
+               end
+      @watts = registers[1151] if abc.energy_monitoring?
+    end
+  end
+end

data/lib/aurora/blower.rb

@@ -36,7 +36,7 @@ module Aurora
 
       def refresh(registers)
         outputs = registers[30]
-        @speed = if outputs.include?(:eh1)
+        @speed = if outputs.include?(:eh1) || outputs.include?(:eh2)
                    4
                  elsif outputs.include?(:cc2)
                    3

data/lib/aurora/component.rb

@@ -6,6 +6,10 @@ module Aurora
       @abc = abc
     end
 
+    def registers_to_read
+      []
+    end
+
     def inspect
       "#<Aurora::#{self.class.name} #{(instance_variables - [:@abc]).map do |iv|
                                         "#{iv}=#{instance_variable_get(iv).inspect}"

data/lib/aurora/compressor.rb

@@ -42,7 +42,7 @@ module Aurora
     end
 
     class VSDrive < GenericCompressor
-      attr_reader :ambient_temperature, :iz2_desired_speed
+      attr_reader :drive_temperature, :inverter_temperature, :ambient_temperature, :iz2_desired_speed, :fan_speed
 
       def initialize(abc)
         super(abc, 12)
@@ -53,7 +53,7 @@ module Aurora
       end
 
       def registers_to_read
-        result = super + [209, 3001, 3326]
+        result = super + [209, 3001, 3326..3327, 3522, 3524]
         result << 564 if abc.iz2?
         result
       end
@@ -63,6 +63,10 @@ module Aurora
 
         @speed = registers[3001]
         @ambient_temperature = registers[3326]
+        @drive_temperature = registers[3327]
+        @inverter_temperature = registers[3522]
+        @fan_speed = registers[3524]
+
         @iz2_desired_speed = registers[564] if abc.iz2?
       end
     end

data/lib/aurora/dhw.rb

@@ -27,7 +27,6 @@ module Aurora
 
       raw_value = (value * 10).to_i
       holding_registers[401] = raw_value
-      @set_point = value
     end
   end
 end

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])
@@ -73,8 +75,6 @@ module Aurora
       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)
@@ -90,8 +90,6 @@ module Aurora
       raise ArgumentError unless (35..65).cover?(dehumidification_target)
 
       holding_registers[abc.iz2? ? 21_115 : 12_310] = (humidification_target << 8) + dehumidification_target
-      @humidification_target = humidification_target
-      @dehumidification_target = dehumidification_target
     end
   end
 end

data/lib/aurora/iz2_zone.rb

@@ -46,28 +46,24 @@ module Aurora
       return unless (raw_value = Aurora::HEATING_MODE.invert[value])
 
       holding_registers[21_202 + ((zone_number - 1) * 9)] = raw_value
-      @target_mode = value
     end
 
     def target_fan_mode=(value)
       return unless (raw_value = Aurora::FAN_MODE.invert[value])
 
       holding_registers[21_205 + ((zone_number - 1) * 9)] = raw_value
-      @target_fan_mode = value
     end
 
     def fan_intermittent_on=(value)
       return unless value >= 0 && value <= 25 && (value % 5).zero?
 
       holding_registers[21_206 + ((zone_number - 1) * 9)] = value
-      @fan_intermittent_on = value
     end
 
     def fan_intermittent_off=(value)
       return unless value >= 0 && value <= 40 && (value % 5).zero?
 
       holding_registers[21_207 + ((zone_number - 1) * 9)] = value
-      @fan_intermittent_off = value
     end
 
     def heating_target_temperature=(value)
@@ -75,7 +71,6 @@ module Aurora
 
       raw_value = (value * 10).to_i
       holding_registers[21_203 + ((zone_number - 1) * 9)] = raw_value
-      @heating_target_temperature = value
     end
 
     def cooling_target_temperature=(value)
@@ -83,7 +78,6 @@ module Aurora
 
       raw_value = (value * 10).to_i
       holding_registers[21_204 + ((zone_number - 1) * 9)] = raw_value
-      @cooling_target_temperature = value
     end
   end
 end

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.
@@ -229,6 +229,8 @@ module Aurora
     0x08 => :blower,
     0x10 => :eh1,
     0x20 => :eh2,
+    # 0x40 => ??, # this turns on and off quite a bit during normal operation
+    # 0x80 => ??, # this turns on occasionally during normal operation; I've only seen it when aux heat is on
     0x200 => :accessory,
     0x400 => :lockout,
     0x800 => :alarm
@@ -703,8 +705,9 @@ module Aurora
     9 => "Compressor Minimum Run Time",
     15 => "Blower Off Delay",
     16 => "Line Voltage",
-    17 => "Aux/E Heat Stage", # this has some complicated condition based on
-    # current inputs and outputs on if it should have a value (310 - v) or (130 - v), or be 0
+    17 => "Aux/E Heat Stage", # this is how long aux/eheat have been requested in seconds
+    # when in eheat mode (explicit on the thermostat), it will stage up to eh2 after 130s
+    # when in aux mode (thermostat set to heat; compressor at full capacity), it will stage up to eh2 after 310s
     19 => "FP1 (Cooling Liquid Line) Temperature",
     20 => "FP2",
     21 => "Condensate", # >= 270 normal, otherwise fault
@@ -867,11 +870,11 @@ module Aurora
     3225 => "VS Drive Details (Safemode 2)",
     3226 => "VS Drive Details (Alarm 1)",
     3227 => "VS Drive Details (Alarm 2)",
-    3327 => "VS Drive Temperature",
     3322 => "VS Drive Discharge Pressure",
     3323 => "VS Drive Suction Pressure",
     3325 => "VS Drive Discharge Temperature",
     3326 => "VS Drive Compressor Ambient Temperature",
+    3327 => "VS Drive Temperature",
     3330 => "VS Drive Entering Water Temperature",
     3331 => "VS Drive Line Voltage",
     3332 => "VS Drive Thermo Power",

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)
@@ -44,14 +48,12 @@ module Aurora
       return unless (raw_value = HEATING_MODE.invert[value])
 
       @abc.modbus_slave.holding_registers[12_606] = raw_value
-      @target_mode = value
     end
 
     def target_fan_mode=(value)
       return unless (raw_value = FAN_MODE.invert[value])
 
       @abc.modbus_slave.holding_registers[12_621] = raw_value
-      @target_fan_mode = value
     end
 
     def heating_target_temperature=(value)
@@ -59,7 +61,6 @@ module Aurora
 
       raw_value = (value * 10).to_i
       @abc.modbus_slave.holding_registers[12_619] = raw_value
-      @heating_target_temperature = value
     end
 
     def cooling_target_temperature=(value)
@@ -67,21 +68,18 @@ module Aurora
 
       raw_value = (value * 10).to_i
       @abc.modbus_slave.holding_registers[12_620] = raw_value
-      @cooling_target_temperature = value
     end
 
     def fan_intermittent_on=(value)
       return unless value >= 0 && value <= 25 && (value % 5).zero?
 
       holding_registers[12_622] = value
-      @fan_intermittent_on = value
     end
 
     def fan_intermittent_off=(value)
       return unless value >= 0 && value <= 40 && (value % 5).zero?
 
       holding_registers[12_623] = value
-      @fan_intermittent_off = value
     end
   end
 end

data/lib/aurora/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: waterfurnace_aurora
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 1.0.1
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-27 00:00:00.000000000 Z
+date: 2022-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ccutrer-serialport
@@ -166,6 +166,7 @@ files:
 - exe/web_aid_tool
 - lib/aurora.rb
 - lib/aurora/abc_client.rb
+- lib/aurora/aux_heat.rb
 - lib/aurora/blower.rb
 - lib/aurora/component.rb
 - lib/aurora/compressor.rb