waterfurnace_aurora 0.3.6 → 0.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e288948a5037bccfc008daaac58c7c604f2531fab6c6554c5a93c47ab8846f2
-  data.tar.gz: 7dde859984d21e24f3915307de12a940e17159715ae2e1047fa80c9955ed5cbf
+  metadata.gz: 9043266cc8a0382960f9ee29954fa9da2c33f8507c3d0075c58d9651618fa128
+  data.tar.gz: 40520db833f13a4caea708589a334b21198ed551376ee70aff666c875257ea03
 SHA512:
-  metadata.gz: ac5d6fb9dd6812cd71903eab37f7a32c89ad5f8790956e7adb4782216d59247873be7c603e362caab4679ca489f496579564bcc683d739caeb69ef86cab103b6
-  data.tar.gz: 826ff34760c126c99e19c8be8a5a929938def25d5078ff7c2141c70136a1120fcc99bf997160b2002187f17bb5009a4ac2b67c433855f90c0f7a84c248ba95f1
+  metadata.gz: b8db6bf0c4f1e19270792fd43d16e06dcb3a1ab357c8553d6cc39bb820f546ff3782472a3c8f7cde7d2323686d7712c2f2699d53b8cd984344bda02982a979bc
+  data.tar.gz: 70d7fa1a21e3c3003f24f1cbe8e5909ceb216002e98d08e3262e9f56a3c2636af775a7e47b2422bbbe7511d8cf5ae390436b0d809f28a4e34f6c21ed609327a1

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,9 +45,15 @@ args = case uri.scheme
        end
 
 client = ModBus::RTUClient.new(*args)
-client.logger = Logger.new($stdout, :debug)
-slave = client.with_slave(1)
+client.logger = Logger.new($stdout)
+client.logger.level = debug_modbus ? :debug : :warn
 
-registers = slave.holding_registers[ARGV[1].to_i]
+slave = client.with_slave(1)
+abc = Aurora::ABCClient.new(slave)
+registers = abc.query_registers(ARGV[1])
 
-puts registers.inspect
+if yaml
+  puts YAML.dump(registers)
+else
+  puts Aurora.print_registers(registers)
+end

data/exe/aurora_mqtt_bridge

@@ -37,21 +37,7 @@ 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+)$/
-              $1.to_i..$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))
-          end
+          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
@@ -85,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|
@@ -139,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/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,11 +41,33 @@ 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)
+      ranges = query.split(",").map do |addr|
+        case addr
+        when "known"
+          Aurora::REGISTER_NAMES.keys
+        when "valid"
+          break Aurora::REGISTER_RANGES
+        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, 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
@@ -58,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.6"
+  VERSION = "0.3.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: waterfurnace_aurora
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.10
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-28 00:00:00.000000000 Z
+date: 2021-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ccutrer-serialport