waterfurnace_aurora 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e43967c61aa8b5c445ec2a6024e9da5ba8cc94205cc853ff07fed0374827dc3
-  data.tar.gz: 875004f5c9835f25f7c18d7e7e7d632f0877db6ac7a3fc8215fa28b68c5ce2b9
+  metadata.gz: 290c5d09deda24b527dbe0b1a00e93481c0951a38ef0be40b36cfd5fb33a4e4a
+  data.tar.gz: 33b16f155897683cc0b9a3c915bc3edeb2cb78e869cbfbc7246bd1da01abac71
 SHA512:
-  metadata.gz: f5d48422906f8dbac8aa83645ab3f46a9481f96d7e4720b75772dfbf2be2cf8456753f5d364a4cde3ad69fb778fd3ba29f23249ec08010806339039264bcbefc
-  data.tar.gz: 3a78e33d93f256e0153ae98b7f8df92da2f3138c246e1b5ef47550f4759d5502725a1d52acb6fe3f084b8a158962538ed73a3c1acf072cc151bf18ad9db2f75d
+  metadata.gz: 82efe304dfc3a00670c8b80b6c27aa304a0eab0f36ff108b7b1bc046b0d3fdd8c28ca028d7995c8910a8216dccd4e756bb0eadf8efd1c9ff9c0cfbd8a157cab0
+  data.tar.gz: 47f9d992e4bac6d79bdf514edbf987f48ea367cfd85d9fe8e7d3bcd63396093b7cebb077aaf7d7332c8208926e14ff9b833520bf7b197ce496d2d57de8f80354

data/exe/aurora_mqtt_bridge

@@ -74,12 +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
 
-          @blower.each do |property|
-            property.value = @abc.blower.public_send(property.id.tr("-", "_"))
+          components.each do |(node, object)|
+            node.each do |property|
+              property.value = object.public_send(property.id.tr("-", "_"))
+            end
           end
 
           if @abc.dhw?
@@ -91,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}"
@@ -126,10 +126,9 @@ class MQTTBridge
       end
       node.property("relative-humidity", "Relative Humidity", :integer, @abc.relative_humidity, unit: "%",
                                                                                                 format: 0..100)
-      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 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")
@@ -143,19 +142,45 @@ class MQTTBridge
         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?
-      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: "%")
+
+      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?
+
+      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("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
 
     if @abc.dhw?

data/lib/aurora/abc_client.rb

@@ -5,6 +5,7 @@ require "uri"
 
 require "aurora/blower"
 require "aurora/iz2_zone"
+require "aurora/pump"
 require "aurora/thermostat"
 
 module Aurora
@@ -40,6 +41,7 @@ module Aurora
                 :serial_number,
                 :zones,
                 :blower,
+                :pump,
                 :faults,
                 :current_mode,
                 :dhw_enabled,
@@ -50,21 +52,19 @@ module Aurora
                 :leaving_water_temperature,
                 :entering_water_temperature,
                 :dhw_water_temperature,
-                :waterflow,
                 :compressor_speed,
                 :outdoor_temperature,
                 :fp1,
                 :fp2,
                 :compressor_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
-      raw_registers = @modbus_slave.holding_registers[88..91, 105...110, 404, 412, 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]
@@ -76,6 +76,13 @@ module Aurora
                 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]
@@ -121,10 +128,11 @@ module Aurora
     end
 
     def refresh
-      registers_to_read = [6, 19..20, 25, 30, 344, 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, 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)
@@ -156,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)
@@ -175,7 +182,6 @@ module Aurora
       @safe_mode                  = [47, 48, 49, 72, 74].include?(@error)
       @compressor_watts           = registers[1147]
       @aux_heat_watts             = registers[1151]
-      @loop_pump_watts            = registers[1165]
       @total_watts                = registers[1153]
 
       @current_mode = if outputs.include?(:lockout)
@@ -197,6 +203,7 @@ module Aurora
                       end
 
       blower.refresh(registers)
+      pump.refresh(registers)
 
       zones.each do |z|
         z.refresh(registers)

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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: waterfurnace_aurora
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Cody Cutrer
@@ -141,6 +141,7 @@ files:
 - 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