waterfurnace_aurora 0.3.8 → 0.3.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c36888a334377168fdfcdc0ef75481925b0249b19d62cae4c381a2dc13b1f80f
-  data.tar.gz: 1533ce2068ba912e12110b6c094b2431fbd8e80593a06b5c9378634ef6418413
+  metadata.gz: fdebb583f3d84e8f1c050e21ac205d29bba5d29d91cb14de2c106a5de26917cd
+  data.tar.gz: 64f7a0b749c050e0041e34d6682f1428320b8bc3762532c62b825f43ff4c40b7
 SHA512:
-  metadata.gz: 7cd4b65faa764dab63a662023710324ffe20874e11c565fab5bd5be30d4edce6d593266cc4ae688d3181f345a2d179d733d74b49524e2581bb26718dc64f2ebf
-  data.tar.gz: 0d6e3ab96d4de61d16c4c4f8e1667b98535a2c95d1c053a836d0107c16a854182bdc259af1905ac85e08ecd88b73c03076d355032f4832a21aa9c47729ff6209
+  metadata.gz: 8ec3c74f737e3d38fd593831246e1153ab2ec5eef39a488aaac43c2c22bf5df92e9e613157e1b101c6af2008d451f3513b3e47a6badae0a01b966d4ed87bc3ee
+  data.tar.gz: 3973f340af41d8645de59291245d599a9d7993691249ad9d0b4b7b7582a11ee5d5f95d8c11493ba1be8d9f7611e755e33e6778114bb14a5197eacb9bac16f119

data/exe/aurora_fetch

@@ -3,7 +3,30 @@
 
 require "aurora"
 require "ccutrer-serialport"
+require "logger"
+require "optparse"
 require "uri"
+require "yaml"
+
+debug_modbus = yaml = false
+
+options = OptionParser.new do |opts|
+  opts.banner = "Usage: aurora_fetch /path/to/serial/port REGISTERS [options]"
+
+  opts.on("--debug-modbus", "Print actual protocol bytes") { debug_modbus = true }
+  opts.on("-y", "--yaml", "Output raw values as YAML") { yaml = true }
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+end
+
+options.parse!
+
+unless ARGV.length == 2
+  puts options
+  exit 1
+end
 
 uri = URI.parse(ARGV[0])
 
@@ -22,8 +45,15 @@ args = case uri.scheme
        end
 
 client = ModBus::RTUClient.new(*args)
+client.logger = Logger.new($stdout)
+client.logger.level = debug_modbus ? :debug : :warn
+
 slave = client.with_slave(1)
 abc = Aurora::ABCClient.new(slave)
 registers = abc.query_registers(ARGV[1])
 
-puts Aurora.print_registers(registers)
+if yaml
+  puts YAML.dump(registers)
+else
+  puts Aurora.print_registers(registers)
+end

data/exe/aurora_monitor

@@ -77,7 +77,10 @@ server.request_callback = lambda { |uid, func, req|
     puts Aurora.print_registers(registers)
   elsif func == 16
     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 }
+    if ignore_awl_heartbeat && [{ 460 => 102, 461 => 0, 462 => 5 },
+                                { 460 => 102, 461 => 0, 462 => 1 }].include?(registers)
+      next
+    end
 
     puts "#{Time.now} ===== write multiple registers to #{uid}:"
     puts Aurora.print_registers(registers)

data/exe/aurora_mqtt_bridge

@@ -71,6 +71,10 @@ class MQTTBridge
             property.value = @abc.public_send(property.id.tr("-", "_"))
           end
 
+          @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|
@@ -125,6 +129,13 @@ class MQTTBridge
       end
     end
 
+    @faults = @homie.node("faults", "Fault History", "ABC") do |node|
+      @abc.faults.each_with_index do |count, i|
+        name = Aurora::FAULTS[i + 1]
+        node.property("e#{i + 1}", name || "E#{i + 1}", :integer, count)
+      end
+    end
+
     @abc.zones.each_with_index do |zone, i|
       type = zone.is_a?(Aurora::IZ2Zone) ? "IntelliZone 2 Zone" : "Thermostat"
       @homie.node("zone#{i + 1}", "Zone #{i + 1}", type) do |node|

data/exe/grab_awl_assets.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+mkdir -p html
+mkdir -p html/css
+mkdir -p html/js
+mkdir -p html/images
+
+IP=${1:-172.20.10.1}
+
+curl http://$IP/ > html/index.htm
+curl http://$IP/config.htm > html/config.htm
+curl http://$IP/favicon.ico > html/favicon.ico
+curl http://$IP/css/index.css > html/css/index.css
+curl http://$IP/css/phone.css > html/css/phone.css
+curl http://$IP/js/indexc.js > html/js/indexc.js
+curl http://$IP/js/configc.js > html/js/configc.js
+curl http://$IP/images/aurora.png > html/images/aurora.png
+curl http://$IP/images/back.png > html/images/back.png
+curl http://$IP/images/cfailed.png > html/images/cfailed.png
+curl http://$IP/images/cgood.png > html/images/cgood.png
+curl http://$IP/images/cidle.png > html/images/cidle.png

data/exe/web_aid_tool

@@ -0,0 +1,161 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "aurora"
+require "ccutrer-serialport"
+require "logger"
+require "optparse"
+require "yaml"
+
+debug_modbus = monitor = mock = false
+
+options = OptionParser.new do |opts|
+  opts.banner = "Usage: web_aid_tool /path/to/serial/port [options]"
+
+  opts.on("--debug-modbus", "Print actual protocol bytes") { debug_modbus = true }
+  opts.on("--mock",
+          "Instead of talking to an actual heat pump, mock it with registers from the given YAML file (instead of a serial port)") do # rubocop:disable Layout/LineLength
+    mock = true
+  end
+  opts.on("--monitor", "Print interperted registers as they are requested, like aurora_monitor") { monitor = true }
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+end
+
+options.parse!
+
+unless ARGV.length == 1
+  puts options
+  exit 1
+end
+
+class MockSlave
+  def initialize(registers)
+    @registers = registers
+  end
+
+  def read_multiple_holding_registers(*queries)
+    result = {}
+    queries.each do |query|
+      Array(query).each do |i|
+        result[i] = @registers[i]
+      end
+    end
+    result
+  end
+
+  def write_holding_register(addr, value)
+    @registers[addr] = value
+  end
+end
+
+if mock
+  slave = MockSlave.new(YAML.load_file(ARGV[0]))
+else
+  uri = URI.parse(ARGV[0])
+
+  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(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)
+  client.logger.level = debug_modbus ? :debug : :warn
+
+  slave = client.with_slave(1)
+end
+
+def parse_query_string(query_string)
+  query_string.split("&").map { |p| p.split("=") }.to_h
+end
+
+# _don't_ do URI escaping
+def encode_result(params)
+  params.map { |p| p.join("=") }.join("&")
+end
+
+require "sinatra"
+
+set :public_folder, "html"
+
+get "/" do
+  send_file "html/index.htm"
+end
+
+units = 0
+
+get "/getunits.cgi" do
+  encode_result(units: units)
+end
+
+get "/setunits.cgi" do
+  units = params["units"].to_i
+  encode_result(error: 0)
+end
+
+get "/config.cgi" do
+  encode_result(
+    "AWL Version" => Aurora::VERSION,
+    "Local Web Version" => 1.08,
+    "SSID" => nil,
+    "Units" => units,
+    "AWL ID" => ARGV[0],
+    "AWL ID CRC" => nil
+  )
+end
+
+get "/request.cgi" do
+  params = parse_query_string(request.query_string)
+  result = params.slice("cmd", "id", "set", "addr")
+  result["err"] = nil
+
+  # these are just aliases to get a certain set of registers
+  case params["cmd"]
+  when "abcinfo"
+    params["regs"] = "2;8;88,4"
+  when "devices"
+    params["regs"] = "800;803;806,3;812;815;818;824"
+  end
+
+  case params["cmd"]
+  when "getregs", "abcinfo", "devices"
+    queries = params["regs"].split(";").map do |range|
+      start, length = range.split(",").map(&:to_i)
+      next start if length.nil?
+
+      start...(start + length)
+    end
+    registers = slave.read_multiple_holding_registers(*queries)
+    puts Aurora.print_registers(registers) if monitor
+    result["values"] = registers.values.join(",")
+  when "putregs"
+    writes = params["regs"].split(";").map do |write|
+      write.split(",").map(&:to_i)
+    end.compact.to_h
+    if monitor
+      puts "WRITING"
+      puts Aurora.print_registers(writes)
+      puts "==="
+    end
+
+    writes.each do |(addr, value)|
+      slave.write_holding_register(addr, value)
+    end
+  else
+    return ""
+  end
+
+  encode_result(result)
+end

data/lib/aurora/abc_client.rb

@@ -5,6 +5,7 @@ module Aurora
     attr_reader :modbus_slave,
                 :serial_number,
                 :zones,
+                :faults,
                 :current_mode,
                 :fan_speed,
                 :entering_air_temperature,
@@ -34,12 +35,13 @@ module Aurora
       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
+      @zones = if iz2?
                  iz2_zone_count = @modbus_slave.holding_registers[483]
                  (0...iz2_zone_count).map { |i| IZ2Zone.new(self, i + 1) }
+               else
+                 [Thermostat.new(self)]
                end
+      @faults = []
     end
 
     def query_registers(query)
@@ -47,6 +49,8 @@ module Aurora
         case addr
         when "known"
           Aurora::REGISTER_NAMES.keys
+        when "valid"
+          break Aurora::REGISTER_RANGES
         when /^(\d+)(?:\.\.|-)(\d+)$/
           $1.to_i..$2.to_i
         else
@@ -62,8 +66,8 @@ module Aurora
     end
 
     def refresh
-      registers_to_read = [19..20, 30, 340, 344, 347, 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
@@ -74,9 +78,12 @@ module Aurora
           registers_to_read << base3
         end
       else
-        registers_to_read << (745..747)
+        registers_to_read << 502
+        registers_to_read << (745..746)
       end
 
+      @faults = @modbus_slave.holding_registers[601..699]
+
       registers = @modbus_slave.holding_registers[*registers_to_read]
       Aurora.transform_registers(registers)
 
@@ -135,6 +142,54 @@ module Aurora
       @modbus_slave.holding_registers[347] = value
     end
 
+    def cooling_airflow_adjustment=(value)
+      value = 0x10000 + value if value.negative?
+      @modbus_slave.holding_registers[346] = value
+    end
+
+    def dhw_enabled=(value)
+      @modbus_slave.holding_registers[400] = value ? 1 : 0
+    end
+
+    def dhw_setpoint=(value)
+      @modbus_slave.holding_registers[401] = value
+    end
+
+    def loop_pressure_trip=(value)
+      @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
+
+    # config aurora system
+    { 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
+        end
+
+        def add_#{component}
+          @modbus_slave.holding_registers[#{register}] = 2
+        end
+
+        def remove_#{component}
+          @modbus_slave.holding_registers[#{register}] = 3
+        end
+      RUBY
+    end
+
     def inspect
       "#<Aurora::ABCClient #{(instance_variables - [:@modbus_slave]).map do |iv|
                                "#{iv}=#{instance_variable_get(iv).inspect}"

data/lib/aurora/modbus/slave.rb

@@ -49,6 +49,7 @@ module Aurora
         when 0x80..0xff
           msg += read(io, 3)
         else
+          log "Rx (#{msg.size} bytes): " + logging_bytes(msg)
           raise ::ModBus::Errors::IllegalFunction, "Illegal function: #{function_code}"
         end
         msg

data/lib/aurora/registers.rb

@@ -3,6 +3,11 @@
 module Aurora
   module_function
 
+  # take an array of ranges, and breaks it up into queryable chunks
+  # the ABC limits to 100 registers per read operation
+  # there also seem to be issues that some ranges can't be read at
+  # the same time as other ranges. possibly correspond to different
+  # components?
   def normalize_ranges(ranges)
     registers = ranges.map { |r| Array(r) }.flatten.sort.uniq
     result = []
@@ -11,7 +16,10 @@ module Aurora
     count = 0
     registers.each_with_index do |r, i|
       run_start ||= r
-      next unless i + 1 == registers.length || r + 1 != registers[i + 1]
+      next unless i + 1 == registers.length ||
+                  r + 1 != registers[i + 1] ||
+                  (r - run_start) == 100 ||
+                  REGISTER_BREAKPOINTS.include?(r + 1)
 
       if r == run_start
         result << r
@@ -23,7 +31,7 @@ module Aurora
       else
         range = run_start..r
         if count + range.count > 100
-          totals << result
+          totals << result unless result.empty?
           result = []
           count = 0
         end
@@ -131,6 +139,18 @@ module Aurora
     }
   end
 
+  COMPONENT_STATUS = {
+    1 => :active,
+    2 => :added,
+    3 => :removed
+  }.freeze
+
+  VS_PUMP_CONTROL = {
+    0x7fff => :off,
+    40 => :min,
+    100 => :max
+  }.freeze
+
   SYSTEM_OUTPUTS = {
     0x01 => :cc, # compressor stage 1
     0x02 => :cc2, # compressor stage 2
@@ -320,9 +340,10 @@ module Aurora
   # intermittent off time allowed: 5, 10, 15, 20, 25, 30, 35, 40
 
   REGISTER_CONVERTERS = {
-    TO_HUNDREDTHS => [2, 3, 807, 813, 816, 817, 819, 820, 825, 828],
+    TO_HUNDREDTHS => [2, 3, 801, 807, 813, 816, 817, 819, 820, 825, 828],
     method(:dipswitch_settings) => [4, 33],
-    TO_TENTHS => [19, 20, 401, 567, 740, 745, 746, 747, 900, 1105, 1106, 1107, 1108, 1110, 1111, 1114, 1117, 1134, 1136,
+    TO_TENTHS => [19, 20, 401, 419, 501, 502, 567, 740, 745, 746, 747, 900,
+                  1105, 1106, 1107, 1108, 1110, 1111, 1114, 1117, 1134, 1136,
                   12_619, 12_620,
                   21_203, 21_204,
                   21_212, 21_213,
@@ -344,7 +365,10 @@ module Aurora
     ->(v) { from_bitmask(v, VS_ALARM1) } => [217],
     ->(v) { from_bitmask(v, VS_ALARM2) } => [218],
     ->(v) { from_bitmask(v, VS_EEV2) } => [280],
+    ->(v) { VS_PUMP_CONTROL[v] } => [323],
     NEGATABLE => [346, 1146],
+    ->(v) { !v.zero? } => [400],
+    ->(v) { COMPONENT_STATUS[v] } => [800, 806, 812, 815, 818, 824, 827],
     ->(v) { from_bitmask(v, AXB_INPUTS) } => [1103],
     ->(v) { from_bitmask(v, AXB_OUTPUTS) } => [1104],
     ->(v) { TO_TENTHS.call(NEGATABLE.call(v)) } => [1136],
@@ -367,7 +391,7 @@ module Aurora
   REGISTER_FORMATS = {
     "%ds" => [1, 6, 9, 15, 84, 85],
     "%dV" => [16, 112],
-    "%0.1fºF" => [19, 20, 401, 567, 740, 745, 746, 747, 900, 1110, 1111, 1114, 1134, 1136,
+    "%0.1fºF" => [19, 20, 401, 501, 502, 567, 740, 745, 746, 747, 900, 1110, 1111, 1114, 1134, 1136,
                   12_619, 12_620,
                   21_203, 21_204,
                   21_212, 21_213,
@@ -379,6 +403,7 @@ module Aurora
                   31_007, 31_010, 31_013, 31_016, 31_019, 31_022],
     "E%d" => [25, 26],
     "%d%%" => [282, 321, 322, 346, 565, 741],
+    "%0.1f psi" => [419],
     "%0.1fA" => [1105, 1106, 1107, 1108],
     "%0.1fgpm" => [1117],
     "%dW" => [1147, 1149, 1151, 1153, 1165],
@@ -390,7 +415,11 @@ module Aurora
   end
 
   def faults(range)
-    range.map { |i| [i, "E#{i % 100}"] }.to_h
+    range.map do |i|
+      name = FAULTS[i % 100]
+      name = " (#{name})" if name
+      [i, "E#{i % 100}#{name}"]
+    end.to_h
   end
 
   def zone_registers
@@ -494,6 +523,12 @@ module Aurora
     61_000..61_009
   ].freeze
 
+  # see normalize_ranges
+  REGISTER_BREAKPOINTS = [
+    12_100,
+    12_500
+  ].freeze
+
   REGISTER_NAMES = {
     1 => "Random Start Delay",
     2 => "ABC Program Version",
@@ -514,6 +549,7 @@ module Aurora
     30 => "System Outputs",
     31 => "Status",
     33 => "DIP Switch Status",
+    36 => "ABC Board Rev",
     50 => "ECM Speed Low (== 5)",
     51 => "ECM Speed Med (== 5)",
     52 => "ECM Speed High (== 5)",
@@ -544,6 +580,7 @@ module Aurora
     284 => "Saturated Suction Temperature", ## ?? data format
     321 => "VS Pump Min",
     322 => "VS Pump Max",
+    323 => "VS Pump Control",
     340 => "Blower Only Speed",
     341 => "Lo Compressor ECM Speed",
     342 => "Hi Compressor ECM Speed",
@@ -551,9 +588,17 @@ module Aurora
     346 => "Cooling Airflow Adjustment",
     347 => "Aux Heat ECM Speed",
     362 => "Active Dehumidify", # any value is true
+    460 => "IZ2??",
+    461 => "IZ2??",
+    462 => "IZ2 Status", # 5 when online; 1 when in setup mode
+    400 => "DHW Enabled",
     401 => "DHW Setpoint",
+    # 403 => "DHW Status", just a guess, based on AID Tool querying this register while showing DHW settings
     414 => "On Peak/SmartGrid 2", # 0x0001 only
+    419 => "Loop Pressure Trip",
     483 => "Number of IZ2 Zones",
+    501 => "Set Point", # only read by AID tool? this is _not_ heating/cooling set point
+    502 => "Ambient Temperature",
     564 => "IZ2 Compressor Speed Desired",
     565 => "IZ2 Blower % Desired",
     567 => "Entering Air",
@@ -561,15 +606,28 @@ module Aurora
     741 => "Relative Humidity",
     745 => "Heating Set Point",
     746 => "Cooling Set Point",
-    747 => "Ambient Temperature",
+    747 => "Ambient Temperature", # from communicating thermostat? but set to 0 when mode is off?
+    800 => "Thermostat Installed",
+    801 => "Thermostat Version",
+    802 => "Thermostat Revision",
+    806 => "AXB Installed",
     807 => "AXB Version",
+    808 => "AXB Revision",
+    812 => "IZ2 Installed",
     813 => "IZ2 Version",
-    816 => "AOC Version 1?",
-    817 => "AOC Version 2?",
-    819 => "MOC Version 1?",
-    820 => "MOC Version 2?",
+    814 => "IZ2 Revision",
+    815 => "AOC Installed",
+    816 => "AOC Version",
+    817 => "AOC Revision",
+    818 => "MOC Installed",
+    819 => "MOC Version",
+    820 => "MOC Revision",
+    824 => "EEV2 Installed",
     825 => "EEV2 Version",
+    826 => "EEV2 Revision",
+    827 => "AWL Installed",
     828 => "AWL Version",
+    829 => "AWL Revision",
     900 => "Leaving Air",
     1103 => "AXB Inputs",
     1104 => "AXB Outputs",