waterfurnace_aurora 0.3.9 → 0.3.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6920a48439c274a9c5f7cec06ebeabf6c97a91018f107d090ce8be793f307f99
-  data.tar.gz: 4a7e518fcca1ec7c52d7bd1bee6d294a59b31e9f0d759270a1a2bcd2f8c75270
+  metadata.gz: a92c5ae13a08cf060e3c7f23613cc1302e20af0bc4bc7c77c610936bea48c2b5
+  data.tar.gz: 914c7c6371755e06524e063b5eb6820ca63f67844713d4d396cd08559fa62cc6
 SHA512:
-  metadata.gz: 504b790c101f15dc79f5985b3fdcab529f746d912aaef0865c59404240f95908ca72a70aa262af4917b7409ac9d5366f24167eddc33ba8ba5786d0213f7b3776
-  data.tar.gz: def8a5362616f511f514a0f3e3008302dfa0fa71d9e7ac4bd0d937cd76083ec6118cc8240e100bf5099cd610926dc912c8d4eaf50b4f7cb5149fcd5cdbbc88a8
+  metadata.gz: 384657c10727cf0a955cf4a4db5270d8ee021629e40c0dee65170e22206e3b0c21c85da2beade4f02143cdd5ff8d5631d5429c6a2957b96d933a3476cf83078c
+  data.tar.gz: 6ea98c0cd77e83158d8313a851b0fa155cc6ee7a042aa338abb27c3c57cec543017b1ab97953aedf11d4645fedd5a6423c35b2c4f75fae6c768cfd1d5e47635d

data/exe/aurora_fetch

@@ -6,23 +6,25 @@ require "ccutrer-serialport"
 require "logger"
 require "optparse"
 require "uri"
+require "yaml"
 
-debug_modbus = false
+debug_modbus = yaml = false
 
-opts = OptionParser.new do |opts|
+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
 
-opts.parse!
+options.parse!
 
 unless ARGV.length == 2
-  puts opts
+  puts options
   exit 1
 end
 
@@ -50,4 +52,8 @@ 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,19 +35,25 @@ 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)
+      implicit = false
       ranges = query.split(",").map do |addr|
         case addr
         when "known"
+          implicit = true
           Aurora::REGISTER_NAMES.keys
+        when "valid"
+          implicit = true
+          break Aurora::REGISTER_RANGES
         when /^(\d+)(?:\.\.|-)(\d+)$/
           $1.to_i..$2.to_i
         else
@@ -57,13 +64,23 @@ module Aurora
       registers = {}
       queries.each do |subquery|
         registers.merge!(@modbus_slave.read_multiple_holding_registers(*subquery))
+      rescue ::ModBus::Errors::IllegalDataAddress
+        # maybe this unit doesn't respond to all the addresses we want?
+        raise unless implicit
+
+        # try each query individually
+        subquery.each do |subsubquery|
+          registers.merge!(@modbus_slave.read_multiple_holding_registers(subsubquery))
+        rescue ::ModBus::Errors::IllegalDataAddress
+          next
+        end
       end
       registers
     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 = [6, 19..20, 25, 30, 340, 344, 347, 362, 740..741, 900, 1110..1111, 1114, 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 +91,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)
 
@@ -92,7 +112,10 @@ module Aurora
       @outdoor_temperature        = registers[31_003]
       @fp1                        = registers[19]
       @fp2                        = registers[20]
-      @locked_out                 = registers[1117]
+      @locked_out                 = registers[25] & 0x8000
+      @error                      = registers[25] & 0x7fff
+      @derated                    = (41..46).include?(@error)
+      @safe_mode                  = [47, 48, 49, 72, 74].include?(@error)
       @blower_only_ecm_speed      = registers[340]
       @aux_heat_ecm_speed         = registers[347]
       @compressor_watts           = registers[1147]
@@ -104,16 +127,20 @@ module Aurora
       outputs = registers[30]
       @current_mode = if outputs.include?(:lockout)
                         :lockout
+                      elsif registers[362]
+                        :dehumidify
                       elsif outputs.include?(:cc2)
                         outputs.include?(:rv) ? :c2 : :h2
                       elsif outputs.include?(:cc)
                         outputs.include?(:rv) ? :c1 : :h1
                       elsif outputs.include?(:eh2)
-                        :eh2
+                        outputs.include?(:rv) ? :eh2 : :emergency
                       elsif outputs.include?(:eh1)
-                        :eh1
+                        outputs.include?(:rv) ? :eh1 : :emergency
                       elsif outputs.include?(:blower)
                         :blower
+                      elsif registers[6]
+                        :waiting
                       else
                         :standby
                       end
@@ -135,6 +162,85 @@ 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
+
+    def clear_fault_history
+      @modbus_slave.holding_registers[47] = 0x5555
+    end
+
+    def manual_operation(mode: :off,
+                         compressor_speed: 0,
+                         blower_speed: :with_compressor,
+                         pump_speed: :with_compressor,
+                         aux_heat: false)
+      raise ArgumentError, "mode must be :off, :heating, or :cooling" unless %i[off heating cooling].include?(mode)
+      raise ArgumentError, "compressor speed must be between 0 and 12" unless (0..12).include?(compressor_speed)
+
+      unless blower_speed == :with_compressor || (0..12).include?(blower_speed)
+        raise ArgumentError,
+              "blower speed must be :with_compressor or between 0 and 12"
+      end
+      unless pump_speed == :with_compressor || (0..100).include?(pump_speed)
+        raise ArgumentError,
+              "pump speed must be :with_compressor or between 0 and 100"
+      end
+
+      value = 0
+      value = 0x7fff if mode == :off
+      value |= 0x100 if mode == :cooling
+      value |= blower_speed == :with_compressor ? 0xf0 : (blower_speed << 4)
+      value |= 0x200 if aux_heat
+
+      @modbus_slave.holding_registers[3002] = value
+      @modbus_slave.holding_registers[323] = pump_speed == :with_compressor ? 0x7fff : pump_speed
+    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}"