waterfurnace_aurora 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8311d85ee1e300bcfbb3228a65cb98a69301f25f27569c36d898faf97c25fbd5
-  data.tar.gz: 86eab096d17d12aa01bb56f253022d64bb806d5aec3b55c6efc16a895b75d111
+  metadata.gz: b8a3d1e80a8e07d73e5efe83005545f360db3475614333fc434885b3e9143092
+  data.tar.gz: 97ea735ee8991898734b87f810d273bb8fc2000b011f569e9908f4ebcad4d1fc
 SHA512:
-  metadata.gz: 7edd9fd909c0b9fe316f306bf00a56eff1108f467718d71c1645596675938abd67c5e727b4f6312d79c1d706df0f22f7d65f475c35061f7b66405add92eec342
-  data.tar.gz: b0a6f4af036ebcd003557777e1fd276e33e56e1cbfbde268ad42a5a5bfa729c9ffa718dd3fd08917aad8beba2bf4d894519de128a5ba1519b5988ba5ddc707f7
+  metadata.gz: 3aea05123fca4194e108b32adde87724547f63e1ef1b9f0a91d4f22856d59b5021f08a998fe3d9956e20f3e745d662001d0beb43d86de69cdd36decb6f5c1af4
+  data.tar.gz: 762f87c0790263751934b592b17252b822276bef351141b49da72d42b953eb6eb3fe553037c71117f8d39e0318bf83b70af4b838905d1e80195860439f117bb9

data/exe/aurora_fetch

@@ -8,20 +8,31 @@ require "optparse"
 require "uri"
 require "yaml"
 
-debug_modbus = yaml = false
+debug_modbus = yaml = ignore_missing_registers = false
 try_individual = nil
 
 options = OptionParser.new do |opts|
   opts.banner = "Usage: aurora_fetch /path/to/serial/port REGISTERS [options]"
 
   opts.separator("")
-  opts.separator("Use `known` to fetch all identified registers. Use `valid` to fetch all registers that will respond.")
+  opts.separator(<<~TEXT)
+    Use `known` to fetch all identified registers. Use `valid` to fetch all registers
+    that should respond. Use `all` to search the entire ModBus address space. Note that
+    logging of current progress is only periodic, and does not log every register it's
+    trying to fetch.
+  TEXT
   opts.separator("")
 
-  opts.on("--debug-modbus", "Print actual protocol bytes") { debug_modbus = true }
+  opts.on("--debug-modbus", "Print actual protocol bytes") do
+    debug_modbus = true
+  end
   opts.on("--[no-]try-individual",
           "Query registers one-by-one if a range has an illegal address. " \
           "Defaults to true for `valid` and `known` special registers, false otherwise.") { |v| try_individual = v }
+  opts.on("--ignore-missing-registers",
+          "For YAML input only, just log a warning when a register doesn't exist, instead of failing") do
+            ignore_missing_registers = true
+          end
   opts.on("-y", "--yaml", "Output raw values as YAML") { yaml = true }
   opts.on("-v", "--version", "Print version") do
     puts Aurora::VERSION
@@ -40,11 +51,11 @@ unless ARGV.length == 2
   exit 1
 end
 
-modbus_slave = Aurora::ABCClient.open_modbus_slave(ARGV[0])
+modbus_slave = Aurora::ABCClient.open_modbus_slave(ARGV[0], ignore_missing_registers: ignore_missing_registers)
 modbus_slave.read_retry_timeout = 15
 modbus_slave.read_retries = 2
-modbus_slave.logger = Logger.new($stdout)
-modbus_slave.logger.level = debug_modbus ? :debug : :warn
+Aurora.logger = modbus_slave.logger = Logger.new($stderr)
+modbus_slave.logger.level = debug_modbus ? :debug : :info
 
 registers = Aurora::ABCClient.query_registers(modbus_slave, ARGV[1], try_individual: try_individual)
 

data/exe/aurora_mqtt_bridge

@@ -90,30 +90,33 @@ class MQTTBridge
     loop do
       begin
         @mutex.synchronize do
-          @abc.refresh
-
-          components = { @homie_abc => @abc,
-                         @aux_heat => @abc.aux_heat,
-                         @compressor => @abc.compressor,
-                         @blower => @abc.blower,
-                         @pump => @abc.pump,
-                         @dhw => @abc.dhw,
-                         @humidistat => @abc.humidistat }.compact
-          @abc.zones.each_with_index do |z, idx|
-            homie_zone = @homie["zone#{idx + 1}"]
-            components[homie_zone] = z
-          end
+          @homie.mqtt.batch_publish do
+            @abc.refresh
+
+            components = { @homie_abc => @abc,
+                           @aux_heat => @abc.aux_heat,
+                           @compressor => @abc.compressor,
+                           @blower => @abc.blower,
+                           @pump => @abc.pump,
+                           @dhw => @abc.dhw,
+                           @humidistat => @abc.humidistat }.compact
+            @abc.zones.each_with_index do |z, idx|
+              homie_zone = @homie["zone#{idx + 1}"]
+              components[homie_zone] = z
+            end
 
-          components.each do |(node, object)|
-            node.each do |property|
-              property.value = object.public_send(property.id.tr("-", "_"))
+            components.each do |(node, object)|
+              node.each do |property|
+                property.value = object.public_send(property.id.tr("-", "_"))
+              end
             end
-          end
 
-          @abc.faults.each_with_index do |fault_count, i|
-            next if fault_count == 0xffff
+            @faults["current"].value = @abc.current_fault
+            @abc.faults.each_with_index do |fault_count, i|
+              next if fault_count == 0xffff
 
-            @faults["e#{i + 1}"].value = fault_count
+              @faults["e#{i + 1}"].value = fault_count
+            end
           end
         end
       rescue => e
@@ -140,6 +143,31 @@ class MQTTBridge
                     @abc.current_mode,
                     format: allowed_modes,
                     hass: { sensor: { state_class: :measurement } })
+      node.property("emergency-shutdown",
+                    "Emergency Shutdown Requested",
+                    :boolean,
+                    @abc.emergency_shutdown?,
+                    hass: :binary_sensor)
+      node.property("load-shed",
+                    "Load Shed Requested",
+                    :boolean,
+                    @abc.load_shed?,
+                    hass: :binary_sensor)
+      node.property("locked-out",
+                    "Is the heat pump currently locked out?",
+                    :boolean,
+                    @abc.locked_out?,
+                    hass: :binary_sensor)
+      node.property("derated",
+                    "Is the compressor currently running at a derated level?",
+                    :boolean,
+                    @abc.derated?,
+                    hass: :binary_sensor)
+      node.property("safe-mode",
+                    "Is the heat pump currently in safe mode?",
+                    :boolean,
+                    @abc.safe_mode?,
+                    hass: :binary_sensor)
       node.property("entering-air-temperature",
                     "Entering Air Temperature",
                     :float,
@@ -156,6 +184,17 @@ class MQTTBridge
                     hass: { sensor: { device_class: :temperature,
                                       state_class: :measurement,
                                       entity_category: :diagnostic } })
+      node.property("low-pressure-switch",
+                    "Low Pressure Switch Status",
+                    :enum,
+                    @abc.low_pressure_switch,
+                    format: %w[open closed])
+      node.property("high-pressure-switch",
+                    "High Pressure Switch Status",
+                    :enum,
+                    @abc.high_pressure_switch,
+                    format: %w[open closed])
+
       if @abc.awl_communicating?
         node.property("leaving-air-temperature",
                       "Leaving Air Temperature",
@@ -227,6 +266,14 @@ class MQTTBridge
                     @abc.compressor.speed,
                     format: @abc.compressor.speed_range,
                     hass: { sensor: { state_class: :measurement } })
+      node.property("saturated-condensor-discharge-temperature",
+                    "Saturated Condensor Discharge Temperature",
+                    :float,
+                    @abc.compressor.saturated_condensor_discharge_temperature,
+                    unit: "°F",
+                    hass: { sensor: { device_class: :temperature,
+                                      state_class: :measurement,
+                                      entity_category: :diagnostic } })
       if @abc.energy_monitoring?
         node.property("watts",
                       "Power Usage",
@@ -271,6 +318,62 @@ class MQTTBridge
                     format: 0..100,
                     hass: { sensor: { state_class: :measurement,
                                       entity_category: :diagnostic } })
+      node.property("discharge-temperature",
+                    "Discharge Temperature",
+                    :float,
+                    @abc.compressor.discharge_temperature,
+                    unit: "°F",
+                    hass: { sensor: { device_class: :temperature,
+                                      state_class: :measurement,
+                                      entity_category: :diagnostic } })
+      node.property("discharge-pressure",
+                    "Discharge Pressure",
+                    :float,
+                    @abc.compressor.discharge_pressure,
+                    unit: "psi",
+                    hass: { sensor: { device_class: :pressure,
+                                      state_class: :measurement,
+                                      entity_category: :diagnostic } })
+      node.property("suction-temperature",
+                    "Suction Temperature",
+                    :float,
+                    @abc.compressor.suction_temperature,
+                    unit: "°F",
+                    hass: { sensor: { device_class: :temperature,
+                                      state_class: :measurement,
+                                      entity_category: :diagnostic } })
+      node.property("suction-pressure",
+                    "Suction Pressure",
+                    :float,
+                    @abc.compressor.suction_pressure,
+                    unit: "psi",
+                    hass: { sensor: { device_class: :pressure,
+                                      state_class: :measurement,
+                                      entity_category: :diagnostic } })
+      node.property("saturated-evaporator-discharge-temperature",
+                    "Saturated Evaporator Discharge Temperature",
+                    :float,
+                    @abc.compressor.saturated_evaporator_discharge_temperature,
+                    unit: "°F",
+                    hass: { sensor: { device_class: :temperature,
+                                      state_class: :measurement,
+                                      entity_category: :diagnostic } })
+      node.property("superheat-temperature",
+                    "SuperHeat Temperature",
+                    :float,
+                    @abc.compressor.superheat_temperature,
+                    unit: "°F",
+                    hass: { sensor: { device_class: :temperature,
+                                      state_class: :measurement,
+                                      entity_category: :diagnostic } })
+      node.property("superheat-percentage",
+                    "SuperHeat Percentage",
+                    :integer,
+                    @abc.compressor.superheat_percentage,
+                    unit: "%",
+                    format: 0..100,
+                    hass: { sensor: { state_class: :measurement,
+                                      entity_category: :diagnostic } })
 
       next unless @abc.iz2?
 
@@ -525,6 +628,12 @@ class MQTTBridge
     end
 
     @faults = @homie.node("faults", "Fault History", "ABC") do |node|
+      node.property("current",
+                    "Current fault",
+                    :integer,
+                    @abc.current_fault,
+                    format: 0..99,
+                    hass: :sensor)
       node.property("clear-history",
                     "Reset Fault Counts",
                     :enum,
@@ -669,12 +778,12 @@ class MQTTBridge
 end
 
 log_level = ARGV.include?("--debug") ? :debug : :warn
-logger = Logger.new($stdout)
-logger.level = log_level
-abc.modbus_slave.logger = logger
+Aurora.logger = Logger.new($stdout)
+Aurora.logger.level = log_level
+abc.modbus_slave.logger = Aurora.logger
 
 device = "aurora-#{abc.serial_number}"
 homie = MQTT::Homie::Device.new(device, "WaterFurnace", mqtt: mqtt_uri)
-homie.logger = logger
+homie.logger = Aurora.logger
 
 MQTTBridge.new(abc, homie)

data/exe/web_aid_tool

@@ -7,13 +7,17 @@ require "logger"
 require "optparse"
 require "yaml"
 
-debug_modbus = monitor = false
+debug_modbus = monitor = ignore_missing_registers = 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("--monitor", "Print interpreted registers as they are requested, like aurora_monitor") { monitor = true }
+  opts.on("--ignore-missing-registers",
+          "For YAML input only, just log a warning when a register doesn't exist, instead of failing") do
+    ignore_missing_registers = true
+  end
   opts.on("-v", "--version", "Print version") do
     puts Aurora::VERSION
     exit
@@ -31,7 +35,7 @@ unless ARGV.length == 1
   exit 1
 end
 
-slave = Aurora::ABCClient.open_modbus_slave(ARGV[0])
+slave = Aurora::ABCClient.open_modbus_slave(ARGV[0], ignore_missing_registers: ignore_missing_registers)
 slave.logger = Logger.new($stdout)
 slave.logger.level = debug_modbus ? :debug : :warn
 

data/lib/aurora/abc_client.rb

@@ -15,7 +15,7 @@ require "aurora/thermostat"
 module Aurora
   class ABCClient
     class << self
-      def open_modbus_slave(uri)
+      def open_modbus_slave(uri, ignore_missing_registers: false)
         uri = URI.parse(uri)
 
         io = case uri.scheme
@@ -32,7 +32,10 @@ module Aurora
                require "aurora/mqtt_modbus"
                return Aurora::MQTTModBus.new(uri)
              else
-               return Aurora::MockABC.new(YAML.load_file(uri.path)) if File.file?(uri.path)
+               if File.file?(uri.path)
+                 return Aurora::MockABC.new(YAML.load_file(uri.path),
+                                            ignore_missing_registers: ignore_missing_registers)
+               end
 
                require "ccutrer-serialport"
                CCutrer::SerialPort.new(uri.path, baud: 19_200, parity: :even)
@@ -54,6 +57,10 @@ module Aurora
             implicit = true
             try_individual = true if try_individual.nil?
             break Aurora::REGISTER_RANGES
+          when "all"
+            implicit = true
+            try_individual = true if try_individual.nil?
+            break 0..65_535
           when /^(\d+)(?:\.\.|-)(\d+)$/
             $1.to_i..$2.to_i
           else
@@ -62,28 +69,48 @@ module Aurora
         end
         queries = Aurora.normalize_ranges(ranges)
         registers = {}
+        last_log_time = nil
         queries.each do |subquery|
+          last_log_time = log_query(last_log_time, subquery.inspect)
           registers.merge!(modbus_slave.read_multiple_holding_registers(*subquery))
-        rescue ::ModBus::Errors::IllegalDataAddress, ::ModBus::Errors::IllegalFunction
+        rescue ::ModBus::Errors::IllegalDataAddress, ::ModBus::Errors::IllegalFunction, ::ModBus::Errors::ModBusTimeout
           # maybe this unit doesn't respond to all the addresses we want?
           raise unless implicit
 
           # try each query individually
           subquery.each do |subsubquery|
+            last_log_time = log_query(last_log_time, subsubquery.inspect)
             registers.merge!(modbus_slave.read_multiple_holding_registers(subsubquery))
-          rescue ::ModBus::Errors::IllegalDataAddress, ::ModBus::Errors::IllegalFunction
+          rescue ::ModBus::Errors::IllegalDataAddress,
+                 ::ModBus::Errors::IllegalFunction,
+                 ::ModBus::Errors::ModBusTimeout => e
+            raise if e.is_a?(::ModBus::Errors::ModBusTimeout) && !try_individual
             next unless try_individual
 
             # seriously?? try each register individually
-            subsubquery.each do |i|
+            Array(subsubquery).each do |i|
+              last_log_time = log_query(last_log_time, i.to_s)
               registers[i] = modbus_slave.holding_registers[i]
             rescue ::ModBus::Errors::IllegalDataAddress, ::ModBus::Errors::IllegalFunction
+              # don't catch ModBusTimeout here... it should have no problem responding to a single register request
               next
             end
           end
         end
         registers
       end
+
+      private
+
+      def log_query(last_log_time, query)
+        last_log_time ||= Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        if now - last_log_time > 5
+          Aurora&.logger&.info("Fetching register(s) #{query}...")
+          last_log_time = now
+        end
+        last_log_time
+      end
     end
 
     attr_reader :modbus_slave,
@@ -97,8 +124,16 @@ module Aurora
                 :pump,
                 :dhw,
                 :humidistat,
+                :current_fault,
                 :faults,
+                :locked_out,
+                :derated,
+                :safe_mode,
                 :current_mode,
+                :low_pressure_switch,
+                :high_pressure_switch,
+                :emergency_shutdown,
+                :load_shed,
                 :entering_air_temperature,
                 :leaving_air_temperature,
                 :leaving_water_temperature,
@@ -109,6 +144,12 @@ module Aurora
                 :line_voltage,
                 :watts
 
+    alias_method :emergency_shutdown?, :emergency_shutdown
+    alias_method :load_shed?, :load_shed
+    alias_method :locked_out?, :locked_out
+    alias_method :derated?, :derated
+    alias_method :safe_mode?, :safe_mode
+
     def initialize(uri)
       @modbus_slave = self.class.open_modbus_slave(uri)
       @modbus_slave.read_retry_timeout = 15
@@ -156,7 +197,9 @@ module Aurora
 
       @faults = []
 
-      @registers_to_read = [6, 19..20, 25, 30, 112, 344, 567, 1104, 1110..1111, 1114, 1150..1153, 1165]
+      @entering_air_register = awl_axb? ? 740 : 567
+      @registers_to_read = [6, 19..20, 25, 30..31, 112, 344, @entering_air_register, 1104, 1110..1111, 1114, 1150..1153,
+                            1165]
       @registers_to_read.concat([741, 31_003]) if awl_communicating?
       @registers_to_read << 900 if awl_axb?
       zones.each do |z|
@@ -183,17 +226,21 @@ module Aurora
 
       outputs = registers[30]
 
-      @entering_air_temperature   = registers[567]
+      @entering_air_temperature   = registers[@entering_air_register]
       @leaving_air_temperature    = registers[900] if awl_axb?
       @leaving_water_temperature  = registers[1110]
       @entering_water_temperature = registers[1111]
       @outdoor_temperature        = registers[31_003]
       @fp1                        = registers[19]
       @fp2                        = registers[20]
-      @locked_out                 = registers[25] & 0x8000
-      @error                      = registers[25] & 0x7fff
-      @derated                    = (41..46).cover?(@error)
-      @safe_mode                  = [47, 48, 49, 72, 74].include?(@error)
+      @locked_out                 = !(registers[25] & 0x8000).zero?
+      @current_fault              = registers[25] & 0x7fff
+      @derated                    = (41..46).cover?(@current_fault)
+      @safe_mode                  = [47, 48, 49, 72, 74].include?(@current_fault)
+      @low_pressure_switch        = registers[31][:lps]
+      @high_pressure_switch       = registers[31][:hps]
+      @emergency_shutdown         = !!registers[31][:emergency_shutdown]
+      @load_shed                  = !!registers[31][:load_shed]
       @line_voltage               = registers[112]
       @watts                      = registers[1153]
 

data/lib/aurora/compressor.rb

@@ -5,7 +5,7 @@ require "aurora/component"
 module Aurora
   module Compressor
     class GenericCompressor < Component
-      attr_reader :speed, :watts
+      attr_reader :speed, :watts, :saturated_condensor_discharge_temperature
 
       def initialize(abc, stages)
         super(abc)
@@ -21,11 +21,9 @@ module Aurora
       end
 
       def registers_to_read
-        if abc.energy_monitoring?
-          [1146..1147]
-        else
-          []
-        end
+        result = [1134]
+        result << (1146..1147) if abc.energy_monitoring?
+        result
       end
 
       def refresh(registers)
@@ -37,12 +35,24 @@ module Aurora
                  else
                    0
                  end
+        @saturated_condensor_discharge_temperature = registers[1134]
         @watts = registers[1146] if abc.energy_monitoring?
       end
     end
 
     class VSDrive < GenericCompressor
-      attr_reader :drive_temperature, :inverter_temperature, :ambient_temperature, :iz2_desired_speed, :fan_speed
+      attr_reader :drive_temperature,
+                  :inverter_temperature,
+                  :ambient_temperature,
+                  :iz2_desired_speed,
+                  :fan_speed,
+                  :discharge_pressure,
+                  :discharge_temperature,
+                  :suction_pressure,
+                  :suction_temperature,
+                  :saturated_evaporator_discharge_temperature,
+                  :superheat_temperature,
+                  :superheat_percentage
 
       def initialize(abc)
         super(abc, 12)
@@ -53,7 +63,7 @@ module Aurora
       end
 
       def registers_to_read
-        result = super + [209, 3001, 3326..3327, 3522, 3524]
+        result = super + [209, 3001, 3322..3327, 3522, 3524, 3808, 3903..3906]
         result << 564 if abc.iz2?
         result
       end
@@ -62,10 +72,17 @@ module Aurora
         super
 
         @speed = registers[3001]
+        @discharge_pressure = registers[3322]
+        @suction_pressure = registers[3323]
+        @discharge_temperature = registers[3325]
         @ambient_temperature = registers[3326]
         @drive_temperature = registers[3327]
         @inverter_temperature = registers[3522]
         @fan_speed = registers[3524]
+        @superheat_percentage = registers[3808]
+        @suction_temperature = registers[3903]
+        @saturated_evaporator_discharge_temperature = registers[3905]
+        @superheat_temperature = registers[3906]
 
         @iz2_desired_speed = registers[564] if abc.iz2?
       end

data/lib/aurora/mock_abc.rb

@@ -4,7 +4,8 @@ module Aurora
   class MockABC
     attr_accessor :logger
 
-    def initialize(registers)
+    def initialize(registers, ignore_missing_registers: false)
+      @ignore_missing_registers = ignore_missing_registers
       @registers = registers
     end
 
@@ -59,6 +60,8 @@ module Aurora
     private
 
     def missing_register(idx)
+      raise ::ModBus::Errors::IllegalDataAddress unless @ignore_missing_registers
+
       logger.warn("missing register #{idx}")
     end
   end

data/lib/aurora/registers.rb

@@ -60,6 +60,7 @@ module Aurora
   end
 
   def to_int32(registers, idx)
+    Aurora&.logger&.warn("Missing register #{idx + 1}") unless registers[idx + 1]
     (registers[idx] << 16) + registers[idx + 1]
   end
 

data/lib/aurora/thermostat.rb

@@ -15,9 +15,9 @@ module Aurora
                 :fan_intermittent_off
 
     def registers_to_read
-      return [31] unless @abc.awl_thermostat?
+      return [] unless @abc.awl_thermostat?
 
-      [31, 502, 745..746, 12_005..12_006]
+      [502, 745..746, 12_005..12_006]
     end
 
     def refresh(registers)

data/lib/aurora/version.rb

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

data/lib/aurora.rb

@@ -15,4 +15,7 @@ ModBus::Client::Slave.prepend(Aurora::ModBus::Slave)
 ModBus::RTUSlave.prepend(Aurora::ModBus::RTU)
 
 module Aurora
+  class << self
+    attr_accessor :logger
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: waterfurnace_aurora
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-28 00:00:00.000000000 Z
+date: 2022-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ccutrer-serialport