waterfurnace_aurora 0.3.0 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 353f714b82fb803a5a816781e39f1e952fea04485fa09d32f36f363b003bcfd3
-  data.tar.gz: 70b12365ae3f13cfca0fd70104d552efee6b520985e2844795a480130ae42929
+  metadata.gz: afe09cd2a6e4d3dea0a4ebe3548c86fb5a0ed25025e07b11565c4706a82267ef
+  data.tar.gz: ded746f6e623b489ea364623307b7589b2d3b7002cd2b051b0be28f26d701252
 SHA512:
-  metadata.gz: 40937d99b2c3cc6044f6ddfda7ef3c8e789192e31e7ca47e5057f18c4deeb5b33a745bcef155a0c78bc35ce598f631e5d3a9bbbb18bb3b739d0aab7c4b87e2c7
-  data.tar.gz: 4c7e83279bce76b4baa09d74b5b56394822405694fbcecc3b8674caedb9eef9e0baeea518305e1268ac39c719e411010c9d78c00ab1cccb9b0378763b0809873
+  metadata.gz: bbe91b347c1056af614f4290a52ec2f2eb3dc64883b30a129ea41d8353626835738fb8169b2081d56d5688f6910e584b1805403317ed4b29de7d6ee674ca8f9a
+  data.tar.gz: 1d6211ea820d958976201635bbfb239c53ab9a1818cc4779263ce6dda72aaaf669ae26751dd2abe5f82038bc21af7d6a6495b398e89bb4f9c1cc20b6cc876cb9

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,11 +3,39 @@
 
 require "aurora"
 require "ccutrer-serialport"
+require "logger"
+require "optparse"
 require "socket"
 require "uri"
 
+diff_only = debug_modbus = ignore_awl_heartbeat = ignore_sensors = false
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: aurora_monitor /path/to/serial/port [options]"
+
+  opts.on("-q", "--quiet",
+          "Enables quiet mode (--diff-only, --ignore-awl-heartbeat, --ignore-sensors) to ease in deciphering new registers") do # rubocop:disable Layout/LineLength
+    diff_only = true
+    ignore_awl_heartbeat = true
+    ignore_sensors = true
+  end
+  opts.on("--diff-only", "Only show registers if they've changed from their previous value") { diff_only = true }
+  opts.on("--debug-modbus", "Print actual protocol bytes") { debug_modbus = true }
+  opts.on("--ignore-awl-heartbeat", "Don't print AWL heartbeat requests") { ignore_awl_heartbeat = true }
+  opts.on("--ignore-sensors", "Don't print sensor registers (i.e. because they change a lot)") { ignore_sensors = true }
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+end.parse!
+
 uri = URI.parse(ARGV[0])
 
+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"
          require "net/telnet/rfc2217"
          [Net::Telnet::RFC2217.new("Host" => uri.host,
@@ -20,23 +48,39 @@ args = if uri.scheme == "telnet" || uri.scheme == "rfc2217"
 
 server = ModBus::RTUServer.new(*args)
 server.promiscuous = true
-server.debug = true
+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
+  next puts Aurora.print_registers(registers) unless diff_only
+
+  new_registers = last_registers.merge(registers)
+  diff = Aurora.diff_registers(last_registers, new_registers)
+  unless diff.empty?
+    puts "#{Time.now} ===== read"
+    puts Aurora.print_registers(diff)
+  end
+  last_registers = new_registers
+end
 
 server.request_callback = lambda { |uid, func, req|
   if func == 68
-    puts "===== no idea to #{uid}: #{req.inspect}"
+    puts "#{Time.now} ===== no idea to #{uid}: #{req.inspect}" unless diff_only
   elsif func == 67
-    puts "===== write discontiguous registers to #{uid}:"
+    puts "#{Time.now} ===== write discontiguous registers to #{uid}:"
     registers = req.map { |p| [p[:addr], p[:val]] }.to_h
     puts Aurora.print_registers(registers)
   elsif func == 16
-    puts "===== write multiple registers to #{uid}:"
     registers = Range.new(req[:addr], req[:addr] + req[:quant] - 1).zip(req[:val]).to_h
+    next if ignore_awl_heartbeat && registers == { 460 => 102, 461 => 0, 462 => 5 }
+
+    puts "#{Time.now} ===== write multiple registers to #{uid}:"
     puts Aurora.print_registers(registers)
   elsif [3, 65, 66].include?(func)
     # no output
   else
-    puts "**** new func #{func}"
+    puts "#{Time.now} **** new func #{func}"
   end
 }
 
@@ -46,9 +90,9 @@ server.response_callback = lambda { |uid, func, res, req|
       puts "wrong number of results"
       next
     end
-    puts "===== read registers from #{uid}"
+    puts "#{Time.now} ===== read registers from #{uid}" unless diff_only
     registers = Range.new(req[:addr], req[:addr] + req[:quant], true).to_a.zip(res).to_h
-    puts Aurora.print_registers(registers)
+    diff_and_print.call(registers)
   elsif func == 65 && res.is_a?(Array) && req
     register_list = []
     req.each { |params| register_list.concat(Range.new(params[:addr], params[:addr] + params[:quant], true).to_a) }
@@ -56,21 +100,21 @@ server.response_callback = lambda { |uid, func, res, req|
       puts "wrong number of results"
       next
     end
-    puts "===== read multiple register ranges from #{uid}"
+    puts "#{Time.now} ===== read multiple register ranges from #{uid}" unless diff_only
     result = register_list.zip(res).to_h
-    puts Aurora.print_registers(result)
+    diff_and_print.call(result)
   elsif func == 66 && res.is_a?(Array) && req
     unless req.length == res.length
       puts "wrong number of results"
       next
     end
-    puts "===== read discontiguous registers from #{uid}"
+    puts "#{Time.now} ===== read discontiguous registers from #{uid}" unless diff_only
     registers = req.zip(res).to_h
-    puts Aurora.print_registers(registers)
+    diff_and_print.call(registers)
   elsif [16, 67, 68].include?(func)
     # no output
   else
-    puts "**** new func #{func}"
+    puts "#{Time.now} **** new func #{func}"
   end
 }
 

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$/
@@ -62,9 +62,10 @@ class MQTTBridge
         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
@@ -75,6 +76,7 @@ class MQTTBridge
              current_mode
              dhw_water_temperature
              entering_air_temperature
+             entering_water_temperature
              fan_speed
              leaving_air_temperature
              leaving_water_temperature
@@ -91,15 +93,15 @@ class MQTTBridge
             @homie_abc[property.to_s.tr("_", "-")].value = @abc.public_send(property)
           end
 
-          @abc.zones.each do |z|
-            homie_zone = @homie["zone#{z.zone_number}"]
+          @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
-        puts "got garbage: #{e}; #{e.backtrace}"
+        warn "got garbage: #{e}; #{e.backtrace}"
         exit 1
       end
       sleep(5)
@@ -134,11 +136,11 @@ class MQTTBridge
       end
     end
 
-    @abc.zones.each do |zone|
+    @abc.zones.each_with_index do |zone, i|
       type = zone.is_a?(Aurora::IZ2Zone) ? "IntelliZone 2 Zone" : "Thermostat"
-      @homie.node("zone#{zone.zone_number}", "Zone #{zone.zone_number}", type) do |node|
+      @homie.node("zone#{i + 1}", "Zone #{i + 1}", type) do |node|
         allowed_modes = %w[off auto cool heat]
-        allowed_modes << "eheat" if !zone.respond_to?(:zone_number) || zone.zone_number == 1
+        allowed_modes << "eheat" if i.zero?
         node.property("target-mode", "Target Heating/Cooling Mode", :enum, zone.target_mode,
                       format: allowed_modes) do |value, property|
           @mutex.synchronize { property.value = zone.target_mode = value.to_sym }
@@ -186,4 +188,13 @@ class MQTTBridge
   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,
@@ -27,6 +28,9 @@ module Aurora
       @modbus_slave = modbus_slave
       @modbus_slave.read_retry_timeout = 15
       @modbus_slave.read_retries = 2
+      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
@@ -48,7 +52,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]

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

@@ -52,7 +52,6 @@ module Aurora
   end
 
   def to_string(registers, idx, length)
-    puts "converting #{idx} of length #{length}"
     (idx...(idx + length)).map do |i|
       (registers[i] >> 8).chr + (registers[i] & 0xff).chr
     end.join.sub(/[ \0]+$/, "")
@@ -349,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],
@@ -495,25 +494,6 @@ module Aurora
     61_000..61_009
   ].freeze
 
-  def read_all_registers(modbus_slave)
-    result = []
-    REGISTER_RANGES.each do |range|
-      # read at most 100 at a time
-      range.each_slice(100) do |keys|
-        result.concat(modbus_slave.holding_registers[keys.first..keys.last])
-      end
-    end
-    REGISTER_RANGES.map(&:to_a).flatten.zip(result).to_h
-  end
-
-  def diff_registers(lhs, rhs)
-    diff = {}
-    lhs.each_key do |k|
-      diff[k] = [lhs[k], rhs[k]] if lhs[k] != rhs[k]
-    end
-    diff
-  end
-
   REGISTER_NAMES = {
     1 => "Random Start Delay",
     2 => "ABC Program Version",
@@ -610,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,6 +628,25 @@ module Aurora
     registers
   end
 
+  def read_all_registers(modbus_slave)
+    result = []
+    REGISTER_RANGES.each do |range|
+      # read at most 100 at a time
+      range.each_slice(100) do |keys|
+        result.concat(modbus_slave.holding_registers[keys.first..keys.last])
+      end
+    end
+    REGISTER_RANGES.map(&:to_a).flatten.zip(result).to_h
+  end
+
+  def diff_registers(lhs, rhs)
+    diff = {}
+    (lhs.keys | rhs.keys).each do |k|
+      diff[k] = rhs[k] if lhs[k] != rhs[k]
+    end
+    diff
+  end
+
   def print_registers(registers)
     result = []
     registers.each do |(k, value)|
@@ -655,15 +654,17 @@ module Aurora
       next if REGISTER_NAMES.key?(k) && REGISTER_NAMES[k].nil?
 
       name = REGISTER_NAMES[k]
+
       value_proc = REGISTER_CONVERTERS.find { |(_, z)| z.include?(k) }&.first || ->(v) { v }
       format = REGISTER_FORMATS.find { |(_, z)| z.include?(k) }&.first || "%s"
       format = "%1$d (0x%1$04x)" unless name
-      name ||= "???"
 
       value = value_proc.arity == 2 ? value_proc.call(registers, k) : value_proc.call(value)
       value = value.join(", ") if value.is_a?(Array)
       value = format(format, value) if value
 
+      name ||= "???"
+
       result << "#{name} (#{k}): #{value}"
     end
     result.join("\n")

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.0"
+  VERSION = "0.3.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: waterfurnace_aurora
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.4
 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