waterfurnace_aurora 0.3.1 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fde3dc688654c589d5638b794484035f3ab7ca8c102fe1ef27bb6365ddd51d22
-  data.tar.gz: 6d679712a9375c94f8a1f7b2fe3fa6102c606a433c0449049ae289773cdaf735
+  metadata.gz: 85309a61ae279d3255db42a0ff3d53a038c1fdcb3c7e02e3febf6b533992a2c3
+  data.tar.gz: be76ef3d6821fbd8535192fd4a55f770234f1736fb280a7a3736fa6c134a1085
 SHA512:
-  metadata.gz: dd90afd3a8f15ddec22ec29f23679d4def25b768b47eaf7adc37c37ab0a5b98bfb98a11811133d67dbbb1afd23b03ea5689fe4be55c2966eb19b68b9b8827667
-  data.tar.gz: 9c855a9730f2a86678876f3866ea7a6583925781e2397e13738b9f413e4b318a89c7860706e22e88c94d090f37afccd775b2b54242b9555530993e7021b995c6
+  metadata.gz: a45f409c8573e02e7b761c6363abfea445f6e86fe58fab96b5e2ed427564ba791ff83c8817c74d2ff90028eae0c35fb4f090c0a28d3e9c6931aab45e2658c580
+  data.tar.gz: b5d793acc1dbca113c11205198b6ad6623b29543b5c5cc095ab8f4ddf0d5d9fbcf98fc5ca586e534d516027bc446bec2ee164fd3bb7f36ba6309b63517b13524

data/exe/aurora_fetch

@@ -18,7 +18,7 @@ args = if uri.scheme == "telnet" || uri.scheme == "rfc2217"
        end
 
 client = ModBus::RTUClient.new(*args)
-client.debug = true
+client.logger = Logger.new($stdout, :debug)
 slave = client.with_slave(1)
 
 registers = slave.holding_registers[ARGV[1].to_i]

data/exe/aurora_mock

@@ -21,7 +21,7 @@ args = if uri.scheme == "telnet" || uri.scheme == "rfc2217"
 port = ARGV[1]&.to_i || 502
 
 server1 = ModBus::RTUServer.new(*args)
-server1.debug = true
+server1.logger = Logger.new($stdout, :debug)
 # AID Tool queries slave 1, AWL queries slave 2; just use both
 slave1 = server1.with_slave(1)
 slave2 = server1.with_slave(2)

data/exe/aurora_monitor

@@ -3,6 +3,7 @@
 
 require "aurora"
 require "ccutrer-serialport"
+require "logger"
 require "optparse"
 require "socket"
 require "uri"
@@ -47,7 +48,8 @@ args = if uri.scheme == "telnet" || uri.scheme == "rfc2217"
 
 server = ModBus::RTUServer.new(*args)
 server.promiscuous = true
-server.debug = debug_modbus
+server.logger = Logger.new($stdout)
+server.logger.level = :debug if debug_modbus
 
 diff_and_print = lambda do |registers|
   registers = registers.slice(*(registers.keys - SENSOR_REGISTERS)) if ignore_sensors

data/exe/aurora_mqtt_bridge

@@ -29,7 +29,7 @@ class MQTTBridge
     @homie = homie
     @mutex = Mutex.new
 
-    @homie.instance_variable_set(:@block, lambda do |topic, value|
+    @homie.out_of_band_topic_proc = lambda do |topic, value|
       @mutex.synchronize do
         case topic
         when /\$modbus$/
@@ -37,8 +37,8 @@ class MQTTBridge
             case addr
             when "known"
               Aurora::REGISTER_NAMES.keys
-            when /^(\d+)\.\.(\d+)$/
-              Regexp.last_match(1).to_i..Regexp.last_match(2).to_i
+            when /^(\d+)(?:\.\.|-)(\d+)$/
+              $1.to_i..$2.to_i
             else
               addr.to_i
             end
@@ -48,47 +48,37 @@ class MQTTBridge
           queries.each do |subquery|
             registers.merge!(@abc.modbus_slave.read_multiple_holding_registers(*subquery))
           end
-          result = Aurora.print_registers(registers)
-          @homie.mqtt.publish("#{@homie.topic}/$modbus/response", result, retain: false, qos: 1)
-        when %r{\$modbus/(\d+)$}
-          register = Regexp.last_match(1).to_i
+          Aurora.print_registers(registers) do |register, v|
+            @homie.mqtt.publish("#{@homie.topic}/$modbus/#{register}", v, retain: false, qos: 1)
+          end
+        when %r{\$modbus/(\d+)/set$}
+          register = $1.to_i
           value = case value
                   when /\d+/
                     value.to_i
                   when /0x(\d+)/
-                    Regexp.last_match(1).to_i(16)
+                    $1.to_i(16)
                   end
           @abc.modbus_slave.holding_registers[register] = value if value
+          registers = { register => @abc.modbus_slave.holding_registers[register] }
+          Aurora.print_registers(registers) do |r, v|
+            @homie.mqtt.publish("#{@homie.topic}/$modbus/#{r}", v, retain: false, qos: 1)
+          end
         end
       end
     rescue StandardError => e
-      puts "failed processing message: #{e}\n#{e.backtrace}"
-    end)
+      warn "failed processing message: #{e}\n#{e.backtrace}"
+    end
 
+    @abc.refresh
     publish_basic_attributes
 
     loop do
       begin
         @mutex.synchronize do
           @abc.refresh
-          %i[compressor_speed
-             current_mode
-             dhw_water_temperature
-             entering_air_temperature
-             fan_speed
-             leaving_air_temperature
-             leaving_water_temperature
-             outdoor_temperature
-             relative_humidity
-             waterflow
-             fp1
-             fp2
-             compressor_watts
-             blower_watts
-             aux_heat_watts
-             loop_pump_watts
-             total_watts].each do |property|
-            @homie_abc[property.to_s.tr("_", "-")].value = @abc.public_send(property)
+          @homie_abc.each do |property|
+            property.value = @abc.public_send(property.id.tr("-", "_"))
           end
 
           @abc.zones.each_with_index do |z, idx|
@@ -99,7 +89,7 @@ class MQTTBridge
           end
         end
       rescue => e
-        puts "got garbage: #{e}; #{e.backtrace}"
+        warn "got garbage: #{e}; #{e.backtrace}"
         exit 1
       end
       sleep(5)
@@ -121,7 +111,9 @@ class MQTTBridge
                     unit: "ºF")
       node.property("leaving-water-temperature", "Leaving Water Temperature", :float, @abc.leaving_water_temperature,
                     unit: "ºF")
-      node.property("outdoor-temperature", "Outdoor Temperature", :float, @abc.outdoor_temperature, unit: "ºF")
+      unless @abc.outdoor_temperature.zero? # TODO: figure out the config if this actually exists
+        node.property("outdoor-temperature", "Outdoor Temperature", :float, @abc.outdoor_temperature, unit: "ºF")
+      end
       node.property("relative-humidity", "Relative Humidity", :integer, @abc.relative_humidity, unit: "%",
                                                                                                 format: 0..100)
       node.property("waterflow", "Waterflow", :float, unit: "gpm")
@@ -132,6 +124,15 @@ class MQTTBridge
         node.property(component.tr("_", "-"), component.tr("_", " ").titleize, :integer,
                       @abc.public_send(component), unit: "W")
       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 }
+      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 }
+      end
     end
 
     @abc.zones.each_with_index do |zone, i|
@@ -181,9 +182,18 @@ class MQTTBridge
 
     # direct access to modbus registers for debugging purposes
     @homie.mqtt.subscribe("#{@homie.topic}/$modbus")
-    @homie.mqtt.subscribe("#{@homie.topic}/$modbus/+")
+    @homie.mqtt.subscribe("#{@homie.topic}/$modbus/+/set")
     @homie.publish
   end
 end
 
-MQTTBridge.new(abc, MQTT::Homie::Device.new("aurora", "Aurora MQTT Bridge", mqtt: mqtt_uri))
+log_level = ARGV.include?("--debug") ? :debug : :warn
+logger = Logger.new($stdout)
+logger.level = log_level
+slave.logger = logger
+
+device = "aurora-#{abc.serial_number}"
+homie = MQTT::Homie::Device.new(device, "Aurora MQTT Bridge", mqtt: mqtt_uri)
+homie.logger = logger
+
+MQTTBridge.new(abc, homie)

data/lib/aurora/abc_client.rb

@@ -3,6 +3,7 @@
 module Aurora
   class ABCClient
     attr_reader :modbus_slave,
+                :serial_number,
                 :zones,
                 :current_mode,
                 :fan_speed,
@@ -17,6 +18,8 @@ module Aurora
                 :outdoor_temperature,
                 :fp1,
                 :fp2,
+                :blower_only_ecm_speed,
+                :aux_heat_ecm_speed,
                 :compressor_watts,
                 :blower_watts,
                 :aux_heat_watts,
@@ -27,17 +30,21 @@ module Aurora
       @modbus_slave = modbus_slave
       @modbus_slave.read_retry_timeout = 15
       @modbus_slave.read_retries = 2
-      iz2_zone_count = @modbus_slave.holding_registers[483]
-      # TODO: better detect IZ2/Non-IZ2
-      @zones = if iz2_zone_count > 1
-                 (0...iz2_zone_count).map { |i| IZ2Zone.new(self, i + 1) }
-               else
+      registers_array = @modbus_slave.holding_registers[105...110]
+      registers = registers_array.each_with_index.map { |r, i| [i + 105, r] }.to_h
+      @serial_number = Aurora.transform_registers(registers)[105]
+
+      @zones = if @modbus_slave.holding_registers[813].zero?
                  [Thermostat.new(self)]
+               else
+                 iz2_zone_count = @modbus_slave.holding_registers[483]
+                 (0...iz2_zone_count).map { |i| IZ2Zone.new(self, i + 1) }
                end
     end
 
     def refresh
-      registers_to_read = [19..20, 30, 344, 740..741, 900, 1110..1111, 1114, 1117, 1147..1153, 1165, 3027, 31_003]
+      registers_to_read = [19..20, 30, 340, 344, 347, 740..741, 900, 1110..1111, 1114, 1117, 1147..1153, 1165, 3027,
+                           31_003]
       if zones.first.is_a?(IZ2Zone)
         zones.each_with_index do |_z, i|
           base1 = 21_203 + i * 9
@@ -48,7 +55,7 @@ module Aurora
           registers_to_read << base3
         end
       else
-        registers_to_read << 745..747
+        registers_to_read << (745..747)
       end
 
       registers = @modbus_slave.holding_registers[*registers_to_read]
@@ -67,6 +74,8 @@ module Aurora
       @fp1                        = registers[19]
       @fp2                        = registers[20]
       @locked_out                 = registers[1117]
+      @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]
@@ -95,6 +104,18 @@ module Aurora
       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 inspect
       "#<Aurora::ABCClient #{(instance_variables - [:@modbus_slave]).map do |iv|
                                "#{iv}=#{instance_variable_get(iv).inspect}"

data/lib/aurora/modbus/slave.rb

@@ -17,7 +17,7 @@ module Aurora
       end
 
       def holding_registers
-        WFProxy.new(self, :holding_register)
+        @holding_registers ||= WFProxy.new(self, :holding_register)
       end
     end
 
@@ -33,7 +33,6 @@ module Aurora
       def read_rtu_response(io)
         # Read the slave_id and function code
         msg = read(io, 2)
-        log logging_bytes(msg)
 
         function_code = msg.getbyte(1)
         case function_code

data/lib/aurora/registers.rb

@@ -348,7 +348,7 @@ module Aurora
     ->(v) { from_bitmask(v, AXB_INPUTS) } => [1103],
     ->(v) { from_bitmask(v, AXB_OUTPUTS) } => [1104],
     ->(v) { TO_TENTHS.call(NEGATABLE.call(v)) } => [1136],
-    ->(v) { HEATING_MODE[v] } => [12_602, 21_202, 21_211, 21_220, 21_229, 21_238, 21_247],
+    ->(v) { HEATING_MODE[v] } => [12_606, 21_202, 21_211, 21_220, 21_229, 21_238, 21_247],
     ->(v) { FAN_MODE[v] } => [12_621, 21_205, 21_214, 21_223, 21_232, 21_241, 21_250],
     ->(v) { from_bitmask(v, HUMIDIFIER_SETTINGS) } => [31_109],
     ->(v) { { humidification_target: v >> 8, dehumidification_target: v & 0xff } } => [31_110],
@@ -497,7 +497,7 @@ module Aurora
   REGISTER_NAMES = {
     1 => "Random Start Delay",
     2 => "ABC Program Version",
-    3 => "IZ2 Version?",
+    3 => "??? Version?",
     4 => "DIP Switch Override",
     6 => "Compressor Anti-Short Cycle Delay",
     8 => "Unit Type?",
@@ -563,7 +563,7 @@ module Aurora
     746 => "Cooling Set Point",
     747 => "Ambient Temperature",
     807 => "AXB Version",
-    813 => "IZ2 Version?",
+    813 => "IZ2 Version",
     816 => "AOC Version 1?",
     817 => "AOC Version 2?",
     819 => "MOC Version 1?",
@@ -590,7 +590,7 @@ module Aurora
     1153 => "Total Watts",
     1157 => "Ht of Rej",
     1165 => "VS Pump Watts",
-    12_602 => "Heating Mode (write)",
+    12_606 => "Heating Mode (write)",
     12_619 => "Heating Setpoint (write)",
     12_620 => "Cooling Setpoint (write)",
     12_621 => "Fan Mode (write)",
@@ -648,7 +648,7 @@ module Aurora
   end
 
   def print_registers(registers)
-    result = []
+    result = [] unless block_given?
     registers.each do |(k, value)|
       # ignored
       next if REGISTER_NAMES.key?(k) && REGISTER_NAMES[k].nil?
@@ -665,8 +665,13 @@ module Aurora
 
       name ||= "???"
 
-      result << "#{name} (#{k}): #{value}"
+      full_value = "#{name} (#{k}): #{value}"
+      if block_given?
+        yield(k, full_value)
+      else
+        result << full_value
+      end
     end
-    result.join("\n")
+    result.join("\n") unless block_given?
   end
 end

data/lib/aurora/thermostat.rb

@@ -21,7 +21,7 @@ module Aurora
     def target_mode=(value)
       return unless (raw_value = HEATING_MODE.invert[value])
 
-      @abc.modbus_slave.holding_registers[12_602] = raw_value
+      @abc.modbus_slave.holding_registers[12_606] = raw_value
       @target_mode = value
     end
 

data/lib/aurora/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: waterfurnace_aurora
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.5
 platform: ruby
 authors:
 - Cody Cutrer
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: 1.4.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: 1.4.4
 - !ruby/object:Gem::Dependency
   name: net-telnet-rfc2217
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement