waterfurnace_aurora 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a429ac21f24ff82252a574e3e9bcd5c1c02c5d819f236f1b2fe05d1517a9039a
-  data.tar.gz: ce6bd7dae57e4d2862191ce2c65e9483655aa489ee4b03824457709fea73a6ec
+  metadata.gz: 0e43967c61aa8b5c445ec2a6024e9da5ba8cc94205cc853ff07fed0374827dc3
+  data.tar.gz: 875004f5c9835f25f7c18d7e7e7d632f0877db6ac7a3fc8215fa28b68c5ce2b9
 SHA512:
-  metadata.gz: 5cef31050d0c211a6fce8f22a47f0a09e5bc17c09f685b45a52faccd39b4bbc40413822abcdc78e0b272b35648672457f3e2880c44d7664c2f6d88ec75fc9437
-  data.tar.gz: 45861b6d6a49dc88f68a9f7ca4b3d5ac15517cbe413b6f5dfd8578963df65b9fc14f6fbd44101b773137269f25a6f06acb6901f1b409067d9f99e81c8bf38af7
+  metadata.gz: f5d48422906f8dbac8aa83645ab3f46a9481f96d7e4720b75772dfbf2be2cf8456753f5d364a4cde3ad69fb778fd3ba29f23249ec08010806339039264bcbefc
+  data.tar.gz: 3a78e33d93f256e0153ae98b7f8df92da2f3138c246e1b5ef47550f4759d5502725a1d52acb6fe3f084b8a158962538ed73a3c1acf072cc151bf18ad9db2f75d

data/exe/aurora_mqtt_bridge

@@ -78,6 +78,10 @@ class MQTTBridge
             property.value = @abc.public_send(property.id.tr("-", "_"))
           end
 
+          @blower.each do |property|
+            property.value = @abc.blower.public_send(property.id.tr("-", "_"))
+          end
+
           if @abc.dhw?
             @dhw["enabled"].value = @abc.dhw_enabled
             @dhw["water-temperature"].value = @abc.dhw_water_temperature
@@ -113,7 +117,6 @@ class MQTTBridge
                     unit: "ºF")
       node.property("entering-water-temperature", "Entering Water Temperature", :float,
                     @abc.entering_water_temperature, unit: "ºF")
-      node.property("fan-speed", "Fan Speed", :integer, @abc.fan_speed, format: 0..11)
       node.property("leaving-air-temperature", "Leaving Air Temperature", :float, @abc.leaving_air_temperature,
                     unit: "ºF")
       node.property("leaving-water-temperature", "Leaving Water Temperature", :float, @abc.leaving_water_temperature,
@@ -126,19 +129,32 @@ class MQTTBridge
       node.property("waterflow", "Waterflow", :float, @abc.waterflow, unit: "gpm")
       node.property("fp1", "FP1 Sensor", :float, @abc.fp1, unit: "ºF")
       node.property("fp2", "FP2 Sensor", :float, @abc.fp2, unit: "ºF")
-      %i[compressor blower aux_heat loop_pump total].each do |component|
+      %i[compressor aux_heat loop_pump total].each do |component|
         component = "#{component}_watts"
         node.property(component.tr("_", "-"), component.tr("_", " ").titleize, :integer,
                       @abc.public_send(component), unit: "W")
       end
+    end
 
-      node.property("blower-only-ecm-speed", "Blower Only ECM Speed", :integer, @abc.blower_only_ecm_speed,
-                    format: 1..12) do |value, property|
-        @mutex.synchronize { property.value = @abc.blower_only_ecm_speed = value }
+    @blower = @homie.node("blower", "Blower", @abc.blower.type) do |node|
+      if @abc.blower.respond_to?(:running)
+        node.property("running", "Blower is running", :boolean, @abc.blower.running?)
+      else
+        node.property("speed", "Current blower speed", :integer, @abc.blower.speed, format: @abc.blower.speed_range)
       end
-      node.property("aux-heat-ecm-speed", "Aux Heat ECM Speed", :integer, @abc.aux_heat_ecm_speed,
-                    format: 1..12) do |value, property|
-        @mutex.synchronize { property.value = @abc.aux_heat_ecm_speed = value }
+      node.property("watts", "Energy Usage", :integer, @abc.blower.watts, unit: "W") if @abc.energy_monitoring?
+      if @abc.blower.is_a?(Aurora::Blower::ECM)
+        %w[blower-only low-compressor high-compressor aux-heat].each do |setting|
+          field = "#{setting.tr('-', '_')}_speed"
+          node.property("#{setting}-speed", "#{setting.tr('-', ' ').titleize} Speed", :integer,
+                        @abc.blower.public_send(field), format: 1..12) do |value, property|
+            @mutex.synchronize { property.value = @abc.blower.public_send("#{field}=", value) }
+          end
+        end
+        if @abc.iz2?
+          node.property("iz2-desired-speed", "IZ2 Desired Speed", :integer, @abc.blower.iz2_desired_speed,
+                        format: 0..100, unit: "%")
+        end
       end
     end
 

data/lib/aurora/abc_client.rb

@@ -3,6 +3,10 @@
 require "yaml"
 require "uri"
 
+require "aurora/blower"
+require "aurora/iz2_zone"
+require "aurora/thermostat"
+
 module Aurora
   class ABCClient
     class << self
@@ -35,9 +39,9 @@ module Aurora
     attr_reader :modbus_slave,
                 :serial_number,
                 :zones,
+                :blower,
                 :faults,
                 :current_mode,
-                :fan_speed,
                 :dhw_enabled,
                 :dhw_setpoint,
                 :entering_air_temperature,
@@ -51,10 +55,7 @@ module Aurora
                 :outdoor_temperature,
                 :fp1,
                 :fp2,
-                :blower_only_ecm_speed,
-                :aux_heat_ecm_speed,
                 :compressor_watts,
-                :blower_watts,
                 :aux_heat_watts,
                 :loop_pump_watts,
                 :total_watts
@@ -63,10 +64,18 @@ module Aurora
       @modbus_slave = self.class.open_modbus_slave(uri)
       @modbus_slave.read_retry_timeout = 15
       @modbus_slave.read_retries = 2
-      registers = Aurora.transform_registers(@modbus_slave.holding_registers[88..91, 105...110, 1114])
+      raw_registers = @modbus_slave.holding_registers[88..91, 105...110, 404, 412, 1114]
+      registers = Aurora.transform_registers(raw_registers.dup)
       @program = registers[88]
       @serial_number = registers[105]
       @dhw_water_temperature = registers[1114]
+      @energy_monitor = raw_registers[412]
+
+      @blower = case raw_registers[404]
+                when 1, 2 then Blower::ECM.new(self, registers[404])
+                when 3 then Blower::FiveSpeed.new(self, registers[404])
+                else; Blower::PSC.new(self, registers[404])
+                end
 
       @zones = if iz2?
                  iz2_zone_count = @modbus_slave.holding_registers[483]
@@ -112,9 +121,10 @@ module Aurora
     end
 
     def refresh
-      registers_to_read = [6, 19..20, 25, 30, 340, 344, 347, 740..741, 900, 1110..1111, 1114, 1117, 1147..1153, 1165,
+      registers_to_read = [6, 19..20, 25, 30, 344, 740..741, 900, 1110..1111, 1114, 1117, 1147..1153, 1165,
                            31_003]
       registers_to_read << (400..401) if dhw?
+      registers_to_read.concat(blower.registers_to_read)
       registers_to_read.concat([362, 3001]) if vs_drive?
 
       if zones.first.is_a?(IZ2Zone)
@@ -138,7 +148,6 @@ module Aurora
 
       outputs = registers[30]
 
-      @fan_speed                  = registers[344]
       @dhw_enabled                = registers[400]
       @dhw_setpoint               = registers[401]
       @entering_air_temperature   = registers[740]
@@ -164,10 +173,7 @@ module Aurora
       @error                      = registers[25] & 0x7fff
       @derated                    = (41..46).include?(@error)
       @safe_mode                  = [47, 48, 49, 72, 74].include?(@error)
-      @blower_only_ecm_speed      = registers[340]
-      @aux_heat_ecm_speed         = registers[347]
       @compressor_watts           = registers[1147]
-      @blower_watts               = registers[1149]
       @aux_heat_watts             = registers[1151]
       @loop_pump_watts            = registers[1165]
       @total_watts                = registers[1153]
@@ -190,6 +196,8 @@ module Aurora
                         :standby
                       end
 
+      blower.refresh(registers)
+
       zones.each do |z|
         z.refresh(registers)
       end
@@ -277,6 +285,10 @@ module Aurora
       @modbus_slave.holding_registers[323] = pump_speed == :with_compressor ? 0x7fff : pump_speed
     end
 
+    def energy_monitoring?
+      @energy_monitor == 2
+    end
+
     def vs_drive?
       @program == "ABCVSP"
     end
@@ -289,7 +301,8 @@ module Aurora
     { thermostat: 800, axb: 806, iz2: 812, aoc: 815, moc: 818, eev2: 824 }.each do |(component, register)|
       class_eval <<-RUBY, __FILE__, __LINE__ + 1
         def #{component}?
-          @modbus_slave.holding_registers[#{register}] != 3
+          return @#{component} if instance_variable_defined?(:@#{component})
+          @#{component} = @modbus_slave.holding_registers[#{register}] != 3
         end
 
         def add_#{component}

data/lib/aurora/blower.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require "aurora/component"
+
+module Aurora
+  module Blower
+    class GenericBlower < Component
+      attr_reader :type, :watts
+
+      def initialize(abc, type)
+        super(abc)
+        @type = type
+      end
+
+      def registers_to_read
+        if abc.energy_monitoring?
+          [1148..1149]
+        else
+          []
+        end
+      end
+
+      def refresh(registers)
+        @watts = registers[1148] if abc.energy_monitoring?
+      end
+    end
+
+    class PSC < GenericBlower
+      attr_reader :running
+      alias running? running
+
+      def refresh(registers)
+        @running = registers[30].include?(:g)
+      end
+    end
+
+    class FiveSpeed < GenericBlower
+      attr_reader :speed
+
+      def speed_range
+        0..4
+      end
+
+      def refresh(registers)
+        outputs = registers[30]
+        @speed = if outputs.include?(:eh1)
+                   4
+                 elsif outputs.include?(:cc2)
+                   3
+                 elsif outputs.include?(:cc)
+                   2
+                 elsif outputs.include?(:g)
+                   1
+                 else
+                   0
+                 end
+      end
+    end
+
+    class ECM < GenericBlower
+      attr_reader :speed, :blower_only_speed, :low_compressor_speed, :high_compressor_speed, :aux_heat_speed,
+                  :iz2_desired_speed
+
+      def speed_range
+        0..12
+      end
+
+      def registers_to_read
+        result = super + [340..342, 344, 347]
+        result << 565 if abc.iz2?
+        result
+      end
+
+      def refresh(registers)
+        super
+
+        @speed                  = registers[344]
+        @blower_only_speed      = registers[340]
+        @low_compressor_speed   = registers[341]
+        @high_compressor_speed  = registers[342]
+        @aux_heat_speed         = registers[347]
+        @iz2_desired_speed      = registers[565] if abc.iz2?
+      end
+
+      { blower_only: 340,
+        low_compressor: 341,
+        high_compressor: 342,
+        aux_heat: 347 }.each do |(setting, register)|
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{setting}_speed=(value)
+            raise ArgumentError unless (1..12).include?(value)
+
+            holding_registers[#{register}] = value
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/aurora/component.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Aurora
+  class Component
+    def initialize(abc)
+      @abc = abc
+    end
+
+    private
+
+    attr_reader :abc
+
+    def holding_registers
+      abc.modbus_slave.holding_registers
+    end
+  end
+end

data/lib/aurora/registers.rb

@@ -234,13 +234,6 @@ module Aurora
     0x800 => :alarm
   }.freeze
 
-  # 5-speed ECM shows
-  #  Aux if eh1 is on
-  #  High if cc2 is on
-  #  Med if cc1 is on
-  #  Low if blower is on
-  #  Off
-
   SYSTEM_INPUTS = {
     0x01 => :y1,
     0x02 => :y2,

data/lib/aurora/thermostat.rb

@@ -1,17 +1,15 @@
 # frozen_string_literal: true
 
+require "aurora/component"
+
 module Aurora
-  class Thermostat
+  class Thermostat < Component
     attr_reader :target_mode,
                 :target_fan_mode,
                 :ambient_temperature,
                 :cooling_target_temperature,
                 :heating_target_temperature
 
-    def initialize(abc)
-      @abc = abc
-    end
-
     def refresh(registers)
       @ambient_temperature = registers[502]
       @heating_target_temperature = registers[746]

data/lib/aurora/version.rb

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

data/lib/aurora.rb

@@ -3,9 +3,7 @@
 require "rmodbus"
 
 require "aurora/abc_client"
-require "aurora/iz2_zone"
 require "aurora/mock_abc"
-require "aurora/thermostat"
 require "aurora/modbus/server"
 require "aurora/modbus/slave"
 require "aurora/registers"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: waterfurnace_aurora
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Cody Cutrer
@@ -134,6 +134,8 @@ files:
 - exe/web_aid_tool
 - lib/aurora.rb
 - lib/aurora/abc_client.rb
+- lib/aurora/blower.rb
+- lib/aurora/component.rb
 - lib/aurora/core_ext/string.rb
 - lib/aurora/iz2_zone.rb
 - lib/aurora/mock_abc.rb