waterfurnace_aurora 1.2.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db7465bb9821e07a0c33d5c63cb51318254f5cc9d2c384a99d9a4d95eab2b452
-  data.tar.gz: 665eab16352134408779673b364abd1f36039619f7e4b34b8e6de1240c904d62
+  metadata.gz: a7e5ad408f03461611331d400d450b031c60303c5beab6bb66e9c31664254107
+  data.tar.gz: 5afceffbfdd8d1e260b7986a5ecb952e7e7eff5ef1e37e996bf7fdbc57eaaa5a
 SHA512:
-  metadata.gz: c369b3c79e7bbb7d77f0f0683029530c66c9d92fc03b059800e48d521ab92201cbae113681d5b3eac2f5cd31fb325d4c7eb64b672eaf743dfc12caab04d73466
-  data.tar.gz: 299bf75e7e0ae9cef453d2be3654d5a1983f2a4f7ac6ec3762b35b386f7bf60fb3bad3826b0ee91eeffb0f6f7acba8ec3f2e64ed49038e3306bc5fca75e6cc64
+  metadata.gz: 1ecbf5e487c96fc722d863a2c7f1ee49398acf1348b7241f94d51b86338c621d1168835e7d4004857eae7790b9fa5b37c5747ed27518f2b10854b060227d0fda
+  data.tar.gz: 4f974c805881669cc12cc25061f2f1c19c6710b5ca9ac0c56bad1acc34023a6fb0364bf98b76277af1b7289c0be14b782fb19b8497d45844983f1a2c7c60f21a

data/exe/aurora_mqtt_bridge

@@ -11,11 +11,13 @@ require "yaml"
 require "aurora/core_ext/string"
 
 debug_modbus = false
+web_aid_tool = nil
 
 options = OptionParser.new do |opts|
   opts.banner = "Usage: aurora_mqtt_bridge /path/to/serial/port [options]"
 
   opts.on("--debug-modbus", "Print actual protocol bytes") { debug_modbus = true }
+  opts.on("--web-aid-tool PORT", "Run web aid tool on given port", :integer) { |v| web_aid_tool = v}
   opts.on("-v", "--version", "Print version") do
     puts Aurora::VERSION
     exit
@@ -36,10 +38,12 @@ end
 mqtt_uri = ARGV[1]
 
 abc = Aurora::ABCClient.new(ARGV[0])
-abc.modbus_slave.logger = Logger.new($stdout)
-abc.modbus_slave.logger.level = debug_modbus ? :debug : :warn
+Aurora.logger = abc.modbus_slave.logger = Logger.new($stdout)
+Aurora.logger.level = debug_modbus ? :debug : :info
 
 class MQTTBridge
+  attr_reader :mutex
+
   def initialize(abc, homie)
     @abc = abc
     @homie = homie
@@ -86,7 +90,9 @@ class MQTTBridge
 
     @abc.refresh
     publish_basic_attributes
+  end
 
+  def join
     loop do
       begin
         @mutex.synchronize do
@@ -282,6 +288,19 @@ class MQTTBridge
                       unit: "W",
                       hass: { sensor: { device_class: :power,
                                         state_class: :measurement } })
+        node.property("heat-of-extraction",
+                      "Heat of Extraction",
+                      :integer,
+                      @abc.compressor.heat_of_extraction,
+                      unit: "Btuh",
+                      hass: { sensor: { state_class: :measurement } })
+        node.property("heat-of-rejection",
+                      "Heat of Rejection",
+                      :integer,
+                      @abc.compressor.heat_of_rejection,
+                      unit: "Btuh",
+                      hass: { sensor: { state_class: :measurement } })
+
       end
 
       next unless @abc.compressor.is_a?(Aurora::Compressor::VSDrive)
@@ -372,6 +391,14 @@ class MQTTBridge
                     hass: { sensor: { device_class: :temperature,
                                       state_class: :measurement,
                                       entity_category: :diagnostic } })
+      node.property("subcool-temperature",
+                    "SubCool Temperature",
+                    :float,
+                    @abc.compressor.subcool_temperature,
+                    unit: "°F",
+                    hass: { sensor: { device_class: :temperature,
+                                      state_class: :measurement,
+                                      entity_category: :diagnostic } })
       node.property("eev-open-percentage",
                     "Electronic Expansion Valve Open Percentage",
                     :integer,
@@ -437,8 +464,7 @@ class MQTTBridge
 
       next unless @abc.blower.is_a?(Aurora::Blower::ECM)
 
-      presets = %w[blower-only aux-heat]
-      presets.concat %w[low-compressor high-compressor] unless @abc.iz2?
+      presets = %w[blower-only aux-heat low-compressor high-compressor]
       presets.each do |setting|
         field = "#{setting.tr("-", "_")}_speed"
         node.property("#{setting}-speed",
@@ -783,13 +809,20 @@ class MQTTBridge
   end
 end
 
-log_level = ARGV.include?("--debug") ? :debug : :warn
-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 = Aurora.logger
 
-MQTTBridge.new(abc, homie)
+mqtt_bridge = MQTTBridge.new(abc, homie)
+
+if web_aid_tool
+  Thread.new { mqtt_bridge.join }
+
+  require "aurora/web_aid_tool"
+  Aurora::WebAIDTool.modbus_slave = abc.modbus_slave
+  Aurora::WebAIDTool.port = web_aid_tool
+  Aurora::WebAIDTool.mutex = mqtt_bridge.mutex
+  Aurora::WebAIDTool.run!
+else
+  mqtt_bridge.join
+end

data/exe/web_aid_tool

@@ -2,16 +2,17 @@
 # frozen_string_literal: true
 
 require "aurora"
-require "ccutrer-serialport"
+require "aurora/web_aid_tool"
 require "logger"
 require "optparse"
-require "yaml"
 
 debug_modbus = monitor = ignore_missing_registers = false
+port = 4567
 
 options = OptionParser.new do |opts|
   opts.banner = "Usage: web_aid_tool /path/to/serial/port [options]"
 
+  opts.on("--port PORT", "Which port to listen on (default 4567)", :integer) { |v| port = v }
   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",
@@ -39,92 +40,7 @@ slave = Aurora::ABCClient.open_modbus_slave(ARGV[0], ignore_missing_registers: i
 slave.logger = Logger.new($stdout)
 slave.logger.level = debug_modbus ? :debug : :warn
 
-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"
-set :logging, false
-
-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)
-    if monitor
-      puts "READING"
-      puts Aurora.print_registers(registers)
-    end
-    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)
-    end
-
-    writes.each do |(addr, value)|
-      slave.write_holding_register(addr, value)
-    end
-  else
-    return ""
-  end
-
-  encode_result(result)
-end
-
-# can't rely on this running automatically when we're installed as a gem,
-# because the wrapper script will confuse it
-Sinatra::Application.run!
+Aurora::WebAIDTool.modbus_slave = slave
+Aurora::WebAIDTool.monitor = monitor
+Aurora::WebAIDTool.port = port
+Aurora::WebAIDTool.run!

data/lib/aurora/compressor.rb

@@ -5,7 +5,12 @@ require "aurora/component"
 module Aurora
   module Compressor
     class GenericCompressor < Component
-      attr_reader :speed, :watts, :cooling_liquid_line_temperature, :saturated_condensor_discharge_temperature
+      attr_reader :speed,
+                  :watts,
+                  :cooling_liquid_line_temperature,
+                  :saturated_condensor_discharge_temperature,
+                  :heat_of_extraction,
+                  :heat_of_rejection
 
       def initialize(abc, stages)
         super(abc)
@@ -22,7 +27,7 @@ module Aurora
 
       def registers_to_read
         result = [19, 1134]
-        result << (1146..1147) if abc.energy_monitoring?
+        result.concat([1146..1147, 1154..1157]) if abc.energy_monitoring?
         result
       end
 
@@ -37,7 +42,12 @@ module Aurora
                  end
         @cooling_liquid_line_temperature = registers[19]
         @saturated_condensor_discharge_temperature = registers[1134]
-        @watts = registers[1146] if abc.energy_monitoring?
+
+        return unless abc.energy_monitoring?
+
+        @watts = registers[1146]
+        @heat_of_extraction = registers[1154]
+        @heat_of_rejection = registers[1156]
       end
     end
 
@@ -54,6 +64,7 @@ module Aurora
                   :suction_temperature,
                   :saturated_evaporator_discharge_temperature,
                   :superheat_temperature,
+                  :subcool_temperature,
                   :eev_open_percentage
 
       def initialize(abc)
@@ -65,7 +76,7 @@ module Aurora
       end
 
       def registers_to_read
-        result = super + [209, 3000..3001, 3322..3327, 3522, 3524, 3808, 3903..3906]
+        result = super + [209, 1135..1136, 3000..3001, 3322..3327, 3522, 3524, 3808, 3903..3906]
         result << 564 if abc.iz2?
         result
       end
@@ -86,6 +97,7 @@ module Aurora
         @suction_temperature = registers[3903]
         @saturated_evaporator_discharge_temperature = registers[3905]
         @superheat_temperature = registers[3906]
+        @subcool_temperature = registers[registers[30].include?(:rv) ? 1136 : 1135]
 
         @iz2_desired_speed = registers[564] if abc.iz2?
       end

data/lib/aurora/mqtt_modbus.rb

@@ -19,7 +19,7 @@ module Aurora
       query_id = SecureRandom.uuid
       mqtt_query = queries.map { |m| m.is_a?(Range) ? "#{m.begin},#{m.count}" : m }.join(";")
       @mqtt.publish("#{@base_topic}/getregs", "#{query_id}:#{mqtt_query}", qos: 1)
-      Timeout.timeout(15) do
+      Timeout.timeout(5) do
         result = {}
         loop do
           packet = @mqtt.get

data/lib/aurora/registers.rb

@@ -44,10 +44,11 @@ module Aurora
     totals
   end
 
+  NEGATABLE = ->(v) { v & 0x8000 == 0x8000 ? v - 0x10000 : v }
   TO_HUNDREDTHS = ->(v) { v.to_f / 100 }
   TO_TENTHS = ->(v) { v.to_f / 10 }
+  TO_SIGNED_TENTHS = ->(v) { NEGATABLE.call(v).to_f / 10 }
   TO_LAST_LOCKOUT = ->(v) { v & 0x8000 == 0x8000 ? v & 0x7fff : nil }
-  NEGATABLE = ->(v) { v & 0x8000 == 0x8000 ? v - 0x10000 : v }
 
   def from_bitmask(value, flags)
     result = []
@@ -59,11 +60,16 @@ module Aurora
     result
   end
 
-  def to_int32(registers, idx)
+  def to_uint32(registers, idx)
     Aurora&.logger&.warn("Missing register #{idx + 1}") unless registers[idx + 1]
     (registers[idx] << 16) + registers[idx + 1]
   end
 
+  def to_int32(registers, idx)
+    v = to_uint32(registers, idx)
+    v & 0x80000000 == 0x80000000 ? v - 0x100000000 : v
+  end
+
   def to_string(registers, idx, length)
     (idx...(idx + length)).map do |i|
       next "\ufffd" unless registers[i] # missing data? add unicode invalid character
@@ -488,18 +494,20 @@ module Aurora
   REGISTER_CONVERTERS = {
     TO_HUNDREDTHS => [2, 3, 417, 418, 801, 804, 807, 813, 816, 817, 819, 820, 825, 828],
     method(:dipswitch_settings) => [4, 33],
-    TO_TENTHS => [19, 20, 401, 419, 501, 502, 567, 740, 745, 746, 747, 900, 901, 903,
-                  1105, 1106, 1107, 1108, 1109, 1110, 1111, 1112, 1113, 1114, 1115, 1116, 1117, 1119, 1124, 1125, 1134,
-                  3322, 3323, 3325, 3326, 3327, 3330, 3522, 3903, 3905, 3906,
+    TO_TENTHS => [401, 419, 745, 746, 901,
+                  1105, 1106, 1107, 1108, 1115, 1116, 1117, 1119,
+                  3322, 3323,
                   12_619, 12_620,
                   21_203, 21_204,
                   21_212, 21_213,
                   21_221, 21_222,
                   21_230, 22_131,
                   21_239, 21_240,
-                  21_248, 21_249,
-                  31_003,
-                  31_007, 31_010, 31_013, 31_016, 31_019, 31_022],
+                  21_248, 21_249],
+    TO_SIGNED_TENTHS => [19, 20, 501, 502, 567, 740, 747, 900, 903,
+                         1109, 1110, 1111, 1112, 1113, 1114, 1124, 1125, 1134, 1135, 1136,
+                         3325, 3326, 3327, 3330, 3522, 3903, 3905, 3906,
+                         31_003, 31_007, 31_010, 31_013, 31_016, 31_019, 31_022],
     TO_LAST_LOCKOUT => [26],
     ->(v) { from_bitmask(v, SYSTEM_OUTPUTS) } => [27, 30],
     ->(v) { from_bitmask(v, SYSTEM_INPUTS) } => [28],
@@ -530,8 +538,8 @@ module Aurora
     ->(v) { COMPONENT_STATUS[v] } => [800, 803, 806, 812, 815, 818, 824, 827],
     method(:axb_inputs) => [1103],
     ->(v) { from_bitmask(v, AXB_OUTPUTS) } => [1104],
-    ->(v) { TO_TENTHS.call(NEGATABLE.call(v)) } => [1135, 1136],
-    method(:to_int32) => [1146, 1148, 1150, 1152, 1154, 1156, 1164, 3422, 3424],
+    method(:to_uint32) => [1146, 1148, 1150, 1152, 1164, 3422, 3424],
+    method(:to_int32) => [1154, 1156],
     method(:manual_operation) => [3002],
     method(:thermostat_configuration2) => [12_006],
     ->(v) { HEATING_MODE[v] } => [12_606, 21_202, 21_211, 21_220, 21_229, 21_238, 21_247],

data/lib/aurora/version.rb

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

data/lib/aurora/web_aid_tool.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require "sinatra/base"
+
+module Aurora
+  class WebAIDTool < Sinatra::Base
+    class << self
+      attr_accessor :modbus_slave, :monitor, :units, :mutex
+    end
+
+    extend Forwardable
+    delegate %i[modbus_slave monitor units units= mutex] => "self.class"
+
+    self.mutex = Mutex.new
+    self.units = 0
+
+    set :public_folder, "html"
+    set :logging, false
+
+    get "/" do
+      send_file "html/index.htm"
+    end
+
+    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 = mutex.synchronize { modbus_slave.read_multiple_holding_registers(*queries) }
+        if monitor
+          puts "READING"
+          puts Aurora.print_registers(registers)
+        end
+        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)
+        end
+
+        mutex.synchronize do
+          writes.each do |(addr, value)|
+            modbus_slave.write_holding_register(addr, value)
+          end
+        end
+      else
+        return ""
+      end
+
+      encode_result(result)
+    end
+
+    private
+
+    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
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: waterfurnace_aurora
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.4.0
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-03 00:00:00.000000000 Z
+date: 2022-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ccutrer-serialport
@@ -92,6 +92,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -182,6 +196,7 @@ files:
 - lib/aurora/registers.rb
 - lib/aurora/thermostat.rb
 - lib/aurora/version.rb
+- lib/aurora/web_aid_tool.rb
 - lib/waterfurnace_aurora.rb
 homepage: https://github.com/ccutrer/waterfurnace_aurora
 licenses: