waterfurnace_aurora 0.4.0 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d7a11b389793a826e3dc602b69ea7aea2ee73afc9839eb1b9df41f38895222e
-  data.tar.gz: c30fad75a07bded088cb3a961e88bf298f5c482eafcb681309693ae00b079de0
+  metadata.gz: c2fb8894c93d6a099f927e91a025fff0faf6a159b29808d089431640f60376b8
+  data.tar.gz: edb0f65d15fdb706aa7471a4f3df1247e8ba354d841b9ef35c1f6874b7376eb0
 SHA512:
-  metadata.gz: 7b0d336748b78005248f5b9b64afb573345a6a0426346bb2d1053d3fdaa4a814a313e5f621ca632d02358f0ec3d2a0c4c2506cb4dada0551c344a595be1f944b
-  data.tar.gz: 0d46028195f215edfe1a1dcf0ec1b7ea50071ba1a7638ba9a2fd0bc3418cd4f451c88e7fb461c741970d683f94eef0c25ec5f2b64db4b80e1ae7ecc0b702a9f4
+  metadata.gz: 2ed469c2b2cb39a166b8664e735579c7f8541eed4f9c3a2c5d7b22046321948925a8bdd2fe08bed455856cf5b36f113040bf9f8f18632f70cdbf9abca9078278
+  data.tar.gz: a01d310d261571b7e2d1aa9537c56072820de03708eb7b9188ccae9d303f5ab54d8c6832f5949667c274247d7ef59066af3c69bd58cc80352d55db27daafbbcc

data/exe/aurora_mqtt_bridge

@@ -74,8 +74,19 @@ class MQTTBridge
       begin
         @mutex.synchronize do
           @abc.refresh
-          @homie_abc.each do |property|
-            property.value = @abc.public_send(property.id.tr("-", "_"))
+
+          components = { @homie_abc => @abc,
+                         @blower => @abc.blower,
+                         @pump => @abc.pump }
+          @abc.zones.each_with_index do |z, idx|
+            homie_zone = @homie["zone#{idx + 1}"]
+            components[homie_zone] = z
+          end
+
+          components.each do |(node, object)|
+            node.each do |property|
+              property.value = object.public_send(property.id.tr("-", "_"))
+            end
           end
 
           if @abc.dhw?
@@ -87,13 +98,6 @@ class MQTTBridge
           @abc.faults.each_with_index do |fault_count, i|
             @faults["e#{i + 1}"].value = fault_count
           end
-
-          @abc.zones.each_with_index do |z, idx|
-            homie_zone = @homie["zone#{idx + 1}"]
-            homie_zone.each do |property|
-              property.value = z.public_send(property.id.tr("-", "_"))
-            end
-          end
         end
       rescue => e
         warn "got garbage: #{e}; #{e.backtrace}"
@@ -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,
@@ -123,22 +126,60 @@ class MQTTBridge
       end
       node.property("relative-humidity", "Relative Humidity", :integer, @abc.relative_humidity, unit: "%",
                                                                                                 format: 0..100)
-      node.property("waterflow", "Waterflow", :float, 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 total].each do |component|
         component = "#{component}_watts"
         node.property(component.tr("_", "-"), component.tr("_", " ").titleize, :integer,
                       @abc.public_send(component), unit: "W")
       end
+    end
+
+    @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("watts", "Energy Usage", :integer, @abc.blower.watts, unit: "W") if @abc.energy_monitoring?
+
+      next unless @abc.blower.is_a?(Aurora::Blower::ECM)
+
+      presets = %w[blower-only aux-heat]
+      presets.concat %w[low-compressor high-compressor] unless @abc.iz2?
+      presets.each do |setting|
+        field = "#{setting.tr('-', '_')}_speed"
+        node.property("#{setting}-speed", "#{setting.tr('-', ' ').titleize} Preset 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
+
+    @pump = @homie.node("pump", "Loop Pump", @abc.pump.type) do |node|
+      node.property("waterflow", "Waterflow", :float, @abc.pump.waterflow, unit: "gpm")
+      node.property("watts", "Energy Usage", :integer, @abc.pump.watts, unit: "W") if @abc.energy_monitoring?
 
-      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 }
+      next unless @abc.pump.is_a?(Aurora::Pump::VSPump)
+
+      node.property("speed", "Speed", :integer, @abc.pump.speed, format: 0..100, unit: "%") do |value, property|
+        @mutex.synchronize { property.value = @abc.pump.speed = value }
+      end
+      node.property("manual-control", "If manual control is enabled", :boolean,
+                    @abc.pump.manual_control?) do |value, property|
+        @mutex.synchronize { property.value = @abc.pump.manual_control = value }
+      end
+      node.property("minimum-speed", "Speed pump runs at compressor speed 0", :integer, @abc.pump.minimum_speed,
+                    format: 0..100, unit: "%") do |value, property|
+        @mutex.synchronize { property.value = @abc.pump.minimum_speed = value }
       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("maximum-speed", "Speed pump runs at compressor speed 12", :integer, @abc.pump.minimum_speed,
+                    format: 0..100, unit: "%") do |value, property|
+        @mutex.synchronize { property.value = @abc.pump.maximum_speed = value }
       end
     end
 

data/lib/aurora/abc_client.rb

@@ -3,6 +3,11 @@
 require "yaml"
 require "uri"
 
+require "aurora/blower"
+require "aurora/iz2_zone"
+require "aurora/pump"
+require "aurora/thermostat"
+
 module Aurora
   class ABCClient
     class << self
@@ -35,9 +40,10 @@ module Aurora
     attr_reader :modbus_slave,
                 :serial_number,
                 :zones,
+                :blower,
+                :pump,
                 :faults,
                 :current_mode,
-                :fan_speed,
                 :dhw_enabled,
                 :dhw_setpoint,
                 :entering_air_temperature,
@@ -46,27 +52,37 @@ module Aurora
                 :leaving_water_temperature,
                 :entering_water_temperature,
                 :dhw_water_temperature,
-                :waterflow,
                 :compressor_speed,
                 :outdoor_temperature,
                 :fp1,
                 :fp2,
-                :blower_only_ecm_speed,
-                :aux_heat_ecm_speed,
                 :compressor_watts,
-                :blower_watts,
                 :aux_heat_watts,
-                :loop_pump_watts,
                 :total_watts
 
     def initialize(uri)
       @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..413, 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
+      @pump = if (3..5).include?(raw_registers[413])
+                Pump::VSPump.new(self,
+                                 registers[413])
+              else
+                Pump::GenericPump.new(self,
+                                      registers[413])
+              end
 
       @zones = if iz2?
                  iz2_zone_count = @modbus_slave.holding_registers[483]
@@ -112,9 +128,11 @@ module Aurora
     end
 
     def refresh
-      registers_to_read = [6, 19..20, 25, 30, 340, 344, 347, 740..741, 900, 1110..1111, 1114, 1147..1153, 1165,
+      registers_to_read = [6, 19..20, 25, 30, 344, 740..741, 900, 1110..1111, 1114, 1147..1153, 1165,
                            31_003]
       registers_to_read << (400..401) if dhw?
+      registers_to_read.concat(blower.registers_to_read)
+      registers_to_read.concat(pump.registers_to_read)
       registers_to_read.concat([362, 3001]) if vs_drive?
 
       if zones.first.is_a?(IZ2Zone)
@@ -138,7 +156,6 @@ module Aurora
 
       outputs = registers[30]
 
-      @fan_speed                  = registers[344]
       @dhw_enabled                = registers[400]
       @dhw_setpoint               = registers[401]
       @entering_air_temperature   = registers[740]
@@ -147,7 +164,6 @@ module Aurora
       @leaving_water_temperature  = registers[1110]
       @entering_water_temperature = registers[1111]
       @dhw_water_temperature      = registers[1114]
-      @waterflow                  = registers[1117]
       @compressor_speed = if vs_drive?
                             registers[3001]
                           elsif outputs.include?(:cc2)
@@ -164,12 +180,8 @@ 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]
 
       @current_mode = if outputs.include?(:lockout)
@@ -190,23 +202,14 @@ module Aurora
                         :standby
                       end
 
+      blower.refresh(registers)
+      pump.refresh(registers)
+
       zones.each do |z|
         z.refresh(registers)
       end
     end
 
-    def blower_only_ecm_speed=(value)
-      return unless (1..12).include?(value)
-
-      @modbus_slave.holding_registers[340] = value
-    end
-
-    def aux_heat_ecm_speed=(value)
-      return unless (1..12).include?(value)
-
-      @modbus_slave.holding_registers[347] = value
-    end
-
     def cooling_airflow_adjustment=(value)
       value = 0x10000 + value if value.negative?
       @modbus_slave.holding_registers[346] = value
@@ -226,20 +229,6 @@ module Aurora
       @modbus_slave.holding_registers[419] = (value * 10).to_i
     end
 
-    def vs_pump_control=(value)
-      raise ArgumentError unless (value = VS_PUMP_CONTROL.invert[value])
-
-      @modbus_slave.holding_registers[323] = value
-    end
-
-    def vs_pump_min=(value)
-      @modbus_slave.holding_registers[321] = value
-    end
-
-    def vs_pump_max=(value)
-      @modbus_slave.holding_registers[322] = value
-    end
-
     def line_voltage=(value)
       raise ArgumentError unless (90..635).include?(value)
 
@@ -277,6 +266,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 +282,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/mock_abc.rb

@@ -44,5 +44,6 @@ module Aurora
     def write_holding_register(addr, value)
       @registers[addr] = value
     end
+    alias []= write_holding_register
   end
 end

data/lib/aurora/pump.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "aurora/component"
+
+module Aurora
+  module Pump
+    class GenericPump < Component
+      attr_reader :type, :watts, :waterflow
+
+      def initialize(abc, type)
+        super(abc)
+        @type = type
+      end
+
+      def registers_to_read
+        result = [1117]
+        result.concat([1164..1165]) if abc.energy_monitoring?
+        result
+      end
+
+      def refresh(registers)
+        @waterflow = registers[1117]
+        @watts = registers[1164] if abc.energy_monitoring?
+      end
+    end
+
+    class VSPump < GenericPump
+      attr_reader :speed, :minimum_speed, :maximum_speed, :manual_control
+      alias manual_control? manual_control
+
+      def registers_to_read
+        super + [321..325]
+      end
+
+      def refresh(registers)
+        super
+        @minimum_speed = registers[321]
+        @maximum_speed = registers[322]
+        @manual_control = registers[323] != :off
+        @speed = registers[325]
+      end
+
+      def manual_control=(value)
+        holding_registers[323] = value ? speed : 0x7fff
+      end
+
+      { speed: 323,
+        minimum_speed: 321,
+        maximum_speed: 322 }.each do |(setting, register)|
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{setting}=(value)
+            raise ArgumentError unless (1..100).include?(value)
+
+            holding_registers[#{register}] = value
+          end
+        RUBY
+      end
+    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,21 +1,19 @@
 # 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]
-      @cooling_target_temperature = registers[745]
+      @heating_target_temperature = registers[745]
+      @cooling_target_temperature = registers[746]
     end
 
     def target_mode=(value)

data/lib/aurora/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Aurora
-  VERSION = "0.4.0"
+  VERSION = "0.4.4"
 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.0
+  version: 0.4.4
 platform: ruby
 authors:
 - Cody Cutrer
@@ -134,11 +134,14 @@ 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
 - lib/aurora/modbus/server.rb
 - lib/aurora/modbus/slave.rb
+- lib/aurora/pump.rb
 - lib/aurora/registers.rb
 - lib/aurora/thermostat.rb
 - lib/aurora/version.rb