waterfurnace_aurora 0.3.7 → 0.3.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: beb1fa2f6415ac6723e0725460e8fbc6f5c8f04c76848034821176ce834f2cf3
-  data.tar.gz: 7a697e8d8bcf8b2abf83bf13c7294498947653f4b4237ede075d1bf01b338bc1
+  metadata.gz: fc29704fadc06f5e325457150e088018586a4f824fc776f0c8736d45f012e30d
+  data.tar.gz: 38820a0d7713c7957d186bdbc6d3ab52cf3064fa94e15370a118058fe777d636
 SHA512:
-  metadata.gz: 4a15073444778a08e9e46c8bedfaf957c7e055d11202e767d592439dfc8ae71f436d89550649a1e6040264e4a81c7189464fa6f9b3e2dc50fe4581a6368d950d
-  data.tar.gz: 722b3a899a1626458dc31c9b0345e85ea64d9e80cd8b40fd5cb6f64241f74752938123eee8b841259496803e6b12643eb014e25b737798aa2e198867e0b37d88
+  metadata.gz: f53b075711ce3df9fdd69b6daa8a1520d6830ae9c8717ede4a8de7c0379420a64e835abefeb56ec481a586f5d328c6f967ad1fca48b08933f6145d927877c8b4
+  data.tar.gz: 5b858edd848f538c59f89a83d8372f6e3682066fac5586d7f3c350dc53a79e0bc23741fd472f3c43456467b8c51fcc6066ba092f1ba3c4a157c453f6937a1c41

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_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,
@@ -40,6 +41,7 @@ module Aurora
                  iz2_zone_count = @modbus_slave.holding_registers[483]
                  (0...iz2_zone_count).map { |i| IZ2Zone.new(self, i + 1) }
                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
@@ -77,6 +81,8 @@ module Aurora
         registers_to_read << (745..747)
       end
 
+      @faults = @modbus_slave.holding_registers[601..699]
+
       registers = @modbus_slave.holding_registers[*registers_to_read]
       Aurora.transform_registers(registers)
 

data/lib/aurora/modbus/slave.rb

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

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
@@ -390,7 +398,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 +506,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",
@@ -594,7 +612,10 @@ module Aurora
     12_619 => "Heating Setpoint (write)",
     12_620 => "Cooling Setpoint (write)",
     12_621 => "Fan Mode (write)",
+    3000 => "Compressor Speed?",
+    3001 => "Compressor Speed?",
     3027 => "Compressor Speed",
+    3904 => "Leaving Air Temperature?",
     31_003 => "Outdoor Temp",
     31_005 => "IZ2 Demand",
     31_109 => "Humidifier Mode", # write to 21114

data/lib/aurora/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: waterfurnace_aurora
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.11
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-29 00:00:00.000000000 Z
+date: 2021-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ccutrer-serialport
@@ -73,33 +73,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
-  type: :development
+        version: '2.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: gserver
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: '9.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -117,8 +117,10 @@ dependencies:
 description: 
 email: cody@cutrer.com'
 executables:
+- grab_awl_assets.sh
 - aurora_monitor
 - aurora_mqtt_bridge
+- web_aid_tool
 - aurora_mock
 - aurora_fetch
 extensions: []
@@ -128,7 +130,8 @@ files:
 - exe/aurora_mock
 - exe/aurora_monitor
 - exe/aurora_mqtt_bridge
-- exe/registers.yml
+- exe/grab_awl_assets.sh
+- exe/web_aid_tool
 - lib/aurora.rb
 - lib/aurora/abc_client.rb
 - lib/aurora/core_ext/string.rb