waterfurnace_aurora 0.3.3 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3127c610617c1008b2de42b4b03fc89867d12233548fc0baf6ea0ebb5ea08e8
-  data.tar.gz: '0190fccfece31159a9c5acdd14b648521c32e7b64f7cb596daeb3548b882393a'
+  metadata.gz: beb1fa2f6415ac6723e0725460e8fbc6f5c8f04c76848034821176ce834f2cf3
+  data.tar.gz: 7a697e8d8bcf8b2abf83bf13c7294498947653f4b4237ede075d1bf01b338bc1
 SHA512:
-  metadata.gz: 5d8ae25889bcea9d6f6e7adfe8e242da729bc5172102688d4790c20a594e094f2aa27c78dfc7104895109bf4dc1636e357e6a03f60cb20918085f95fb8059211
-  data.tar.gz: 72682b009c4f19ff335d1b19759ccd813130148e9d5cfabfb9c915c88a497dbcc3290b2a36e1ef173e513843fd9e19827080236c092fd311618f88ac128e3de4
+  metadata.gz: 4a15073444778a08e9e46c8bedfaf957c7e055d11202e767d592439dfc8ae71f436d89550649a1e6040264e4a81c7189464fa6f9b3e2dc50fe4581a6368d950d
+  data.tar.gz: 722b3a899a1626458dc31c9b0345e85ea64d9e80cd8b40fd5cb6f64241f74752938123eee8b841259496803e6b12643eb014e25b737798aa2e198867e0b37d88

data/exe/aurora_fetch

@@ -7,20 +7,23 @@ require "uri"
 
 uri = URI.parse(ARGV[0])
 
-args = if uri.scheme == "telnet" || uri.scheme == "rfc2217"
+args = case uri.scheme
+       when "tcp"
+         require "socket"
+         [TCPSocket.new(uri.host, uri.port)]
+       when "telnet", "rfc2217"
          require "net/telnet/rfc2217"
-         [Net::Telnet::RFC2217.new("Host" => uri.host,
-                                   "Port" => uri.port || 23,
-                                   "baud" => 19_200,
-                                   "parity" => Net::Telnet::RFC2217::EVEN)]
+         [Net::Telnet::RFC2217.new(uri.host,
+                                   port: uri.port || 23,
+                                   baud: 19_200,
+                                   parity: :even)]
        else
          [CCutrer::SerialPort.new(uri.path, baud: 19_200, parity: :even)]
        end
 
 client = ModBus::RTUClient.new(*args)
-client.logger = Logger.new($stdout, :debug)
 slave = client.with_slave(1)
+abc = Aurora::ABCClient.new(slave)
+registers = abc.query_registers(ARGV[1])
 
-registers = slave.holding_registers[ARGV[1].to_i]
-
-puts registers.inspect
+puts Aurora.print_registers(registers)

data/exe/aurora_mock

@@ -8,12 +8,16 @@ require "yaml"
 
 uri = URI.parse(ARGV[0])
 
-args = if uri.scheme == "telnet" || uri.scheme == "rfc2217"
+args = case uri.scheme
+       when "tcp"
+         require "socket"
+         [TCPSocket.new(uri.host, uri.port)]
+       when "telnet", "rfc2217"
          require "net/telnet/rfc2217"
-         [Net::Telnet::RFC2217.new("Host" => uri.host,
-                                   "Port" => uri.port || 23,
-                                   "baud" => 19_200,
-                                   "parity" => Net::Telnet::RFC2217::EVEN)]
+         [Net::Telnet::RFC2217.new(uri.host,
+                                   port: uri.port || 23,
+                                   baud: 19_200,
+                                   parity: :even)]
        else
          [CCutrer::SerialPort.new(uri.path, baud: 19_200, parity: :even)]
        end

data/exe/aurora_monitor

@@ -36,12 +36,16 @@ last_registers = {}
 SENSOR_REGISTERS = [16, 19, 20, 740, 900, 1109, 1105, 1106, 1107, 1108, 1110, 1111, 1114, 1117, 1134, 1147, 1149, 1151,
                     1153, 1165].freeze
 
-args = if uri.scheme == "telnet" || uri.scheme == "rfc2217"
+args = case uri.scheme
+       when "tcp"
+         require "socket"
+         [TCPSocket.new(uri.host, uri.port)]
+       when "telnet", "rfc2217"
          require "net/telnet/rfc2217"
-         [Net::Telnet::RFC2217.new("Host" => uri.host,
-                                   "Port" => uri.port || 23,
-                                   "baud" => 19_200,
-                                   "parity" => Net::Telnet::RFC2217::EVEN)]
+         [Net::Telnet::RFC2217.new(uri.host,
+                                   port: uri.port || 23,
+                                   baud: 19_200,
+                                   parity: :even)]
        else
          [CCutrer::SerialPort.new(uri.path, baud: 19_200, parity: :even)]
        end
@@ -49,7 +53,7 @@ args = if uri.scheme == "telnet" || uri.scheme == "rfc2217"
 server = ModBus::RTUServer.new(*args)
 server.promiscuous = true
 server.logger = Logger.new($stdout)
-server.logger.level = :debug if debug_modbus
+server.logger.level = debug_modbus ? :debug : :warn
 
 diff_and_print = lambda do |registers|
   registers = registers.slice(*(registers.keys - SENSOR_REGISTERS)) if ignore_sensors

data/exe/aurora_mqtt_bridge

@@ -10,12 +10,16 @@ require "aurora/core_ext/string"
 uri = URI.parse(ARGV[0])
 mqtt_uri = ARGV[1]
 
-args = if uri.scheme == "telnet" || uri.scheme == "rfc2217"
+args = case uri.scheme
+       when "tcp"
+         require "socket"
+         [TCPSocket.new(uri.host, uri.port)]
+       when "telnet", "rfc2217"
          require "net/telnet/rfc2217"
-         [Net::Telnet::RFC2217.new("Host" => uri.host,
-                                   "Port" => uri.port || 23,
-                                   "baud" => 19_200,
-                                   "parity" => Net::Telnet::RFC2217::EVEN)]
+         [Net::Telnet::RFC2217.new(uri.host,
+                                   port: uri.port || 23,
+                                   baud: 19_200,
+                                   parity: :even)]
        else
          [CCutrer::SerialPort.new(uri.path, baud: 19_200, parity: :even)]
        end
@@ -33,36 +37,27 @@ class MQTTBridge
       @mutex.synchronize do
         case topic
         when /\$modbus$/
-          query = value.split(",").map do |addr|
-            case addr
-            when "known"
-              Aurora::REGISTER_NAMES.keys
-            when /^(\d+)\.\.(\d+)$/
-              Regexp.last_match(1).to_i..Regexp.last_match(2).to_i
-            else
-              addr.to_i
-            end
-          end
-          queries = Aurora.normalize_ranges(query)
-          registers = {}
-          queries.each do |subquery|
-            registers.merge!(@abc.modbus_slave.read_multiple_holding_registers(*subquery))
+          registers = @abc.query_registers(value)
+          Aurora.print_registers(registers) do |register, v|
+            @homie.mqtt.publish("#{@homie.topic}/$modbus/#{register}", v, retain: false, qos: 1)
           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
+        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
-      logger.error("failed processing message: #{e}\n#{e.backtrace}")
+      warn "failed processing message: #{e}\n#{e.backtrace}"
     end
 
     @abc.refresh
@@ -72,25 +67,8 @@ class MQTTBridge
       begin
         @mutex.synchronize do
           @abc.refresh
-          %i[compressor_speed
-             current_mode
-             dhw_water_temperature
-             entering_air_temperature
-             entering_water_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|
@@ -101,7 +79,7 @@ class MQTTBridge
           end
         end
       rescue => e
-        logger.error("got garbage: #{e}; #{e.backtrace}")
+        warn "got garbage: #{e}; #{e.backtrace}"
         exit 1
       end
       sleep(5)
@@ -123,7 +101,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")
@@ -134,6 +114,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|
@@ -183,7 +172,7 @@ 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

data/lib/aurora/abc_client.rb

@@ -18,6 +18,8 @@ module Aurora
                 :outdoor_temperature,
                 :fp1,
                 :fp2,
+                :blower_only_ecm_speed,
+                :aux_heat_ecm_speed,
                 :compressor_watts,
                 :blower_watts,
                 :aux_heat_watts,
@@ -31,17 +33,37 @@ module Aurora
       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]
-      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
+
+      @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 query_registers(query)
+      ranges = query.split(",").map do |addr|
+        case addr
+        when "known"
+          Aurora::REGISTER_NAMES.keys
+        when /^(\d+)(?:\.\.|-)(\d+)$/
+          $1.to_i..$2.to_i
+        else
+          addr.to_i
+        end
+      end
+      queries = Aurora.normalize_ranges(ranges)
+      registers = {}
+      queries.each do |subquery|
+        registers.merge!(@modbus_slave.read_multiple_holding_registers(*subquery))
+      end
+      registers
+    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
@@ -52,7 +74,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]
@@ -71,6 +93,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]
@@ -99,6 +123,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/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.3"
+  VERSION = "0.3.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: waterfurnace_aurora
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.7
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-26 00:00:00.000000000 Z
+date: 2021-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ccutrer-serialport
@@ -44,14 +44,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: rmodbus-ccutrer
   requirement: !ruby/object:Gem::Requirement