waterfurnace_aurora 0.3.13 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a92c5ae13a08cf060e3c7f23613cc1302e20af0bc4bc7c77c610936bea48c2b5
-  data.tar.gz: 914c7c6371755e06524e063b5eb6820ca63f67844713d4d396cd08559fa62cc6
+  metadata.gz: 290c5d09deda24b527dbe0b1a00e93481c0951a38ef0be40b36cfd5fb33a4e4a
+  data.tar.gz: 33b16f155897683cc0b9a3c915bc3edeb2cb78e869cbfbc7246bd1da01abac71
 SHA512:
-  metadata.gz: 384657c10727cf0a955cf4a4db5270d8ee021629e40c0dee65170e22206e3b0c21c85da2beade4f02143cdd5ff8d5631d5429c6a2957b96d933a3476cf83078c
-  data.tar.gz: 6ea98c0cd77e83158d8313a851b0fa155cc6ee7a042aa338abb27c3c57cec543017b1ab97953aedf11d4645fedd5a6423c35b2c4f75fae6c768cfd1d5e47635d
+  metadata.gz: 82efe304dfc3a00670c8b80b6c27aa304a0eab0f36ff108b7b1bc046b0d3fdd8c28ca028d7995c8910a8216dccd4e756bb0eadf8efd1c9ff9c0cfbd8a157cab0
+  data.tar.gz: 47f9d992e4bac6d79bdf514edbf987f48ea367cfd85d9fe8e7d3bcd63396093b7cebb077aaf7d7332c8208926e14ff9b833520bf7b197ce496d2d57de8f80354

data/exe/aurora_fetch

@@ -28,28 +28,10 @@ unless ARGV.length == 2
   exit 1
 end
 
-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)
-abc = Aurora::ABCClient.new(slave)
+abc = Aurora::ABCClient.new(ARGV[0])
+abc.modbus_slave.logger = Logger.new($stdout)
+abc.modbus_slave.logger.level = debug_modbus ? :debug : :warn
+
 registers = abc.query_registers(ARGV[1])
 
 if yaml

data/exe/aurora_mock

@@ -2,29 +2,29 @@
 # frozen_string_literal: true
 
 require "aurora"
-require "ccutrer-serialport"
 require "uri"
 require "yaml"
 
 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
+io = 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
+       require "ccutrer-serialport"
+       CCutrer::SerialPort.new(uri.path, baud: 19_200, parity: :even)
+     end
 
 port = ARGV[1]&.to_i || 502
 
-server1 = ModBus::RTUServer.new(*args)
+server1 = ModBus::RTUServer.new(io)
 server1.logger = Logger.new($stdout, :debug)
 # AID Tool queries slave 1, AWL queries slave 2; just use both
 slave1 = server1.with_slave(1)
@@ -35,7 +35,7 @@ slave255 = server2.with_slave(255)
 r = slave1.holding_registers = slave2.holding_registers = slave255.holding_registers = Array.new(31_473, 0)
 
 # prepopulate some data
-registers = YAML.safe_load(File.read(File.expand_path("registers.yml", __dir__)))
+registers = YAML.safe_load(File.read(ARGV[2]))
 registers.each { |(k, v)| r[k] = v }
 
 server1.request_callback = lambda { |uid, func, req|

data/exe/aurora_monitor

@@ -2,7 +2,6 @@
 # frozen_string_literal: true
 
 require "aurora"
-require "ccutrer-serialport"
 require "logger"
 require "optparse"
 require "socket"
@@ -10,7 +9,7 @@ require "uri"
 
 diff_only = debug_modbus = ignore_awl_heartbeat = ignore_sensors = false
 
-OptionParser.new do |opts|
+options = OptionParser.new do |opts|
   opts.banner = "Usage: aurora_monitor /path/to/serial/port [options]"
 
   opts.on("-q", "--quiet",
@@ -27,7 +26,14 @@ OptionParser.new do |opts|
     puts opts
     exit
   end
-end.parse!
+end
+
+options.parse!
+
+unless ARGV.length == 2
+  puts options
+  exit 1
+end
 
 uri = URI.parse(ARGV[0])
 
@@ -36,21 +42,22 @@ last_registers = {}
 SENSOR_REGISTERS = [16, 19, 20, 740, 900, 1109, 1105, 1106, 1107, 1108, 1110, 1111, 1114, 1117, 1134, 1147, 1149, 1151,
                     1153, 1165].freeze
 
-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
-
-server = ModBus::RTUServer.new(*args)
+io = 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
+       require "ccutrer-serialport"
+       CCutrer::SerialPort.new(uri.path, baud: 19_200, parity: :even)
+     end
+
+server = ModBus::RTUServer.new(io)
 server.promiscuous = true
 server.logger = Logger.new($stdout)
 server.logger.level = debug_modbus ? :debug : :warn

data/exe/aurora_mqtt_bridge

@@ -5,27 +5,34 @@ require "aurora"
 require "homie-mqtt"
 require "ccutrer-serialport"
 require "uri"
+require "optparse"
+require "yaml"
 require "aurora/core_ext/string"
 
-uri = URI.parse(ARGV[0])
+debug_modbus = false
+
+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("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+end
+
+options.parse!
+
+unless ARGV.length == 2
+  puts options
+  exit 1
+end
+
 mqtt_uri = ARGV[1]
 
-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
-
-slave = ModBus::RTUClient.new(*args).with_slave(1)
-abc = Aurora::ABCClient.new(slave)
+abc = Aurora::ABCClient.new(ARGV[0])
+abc.modbus_slave.logger = Logger.new($stdout)
+abc.modbus_slave.logger.level = debug_modbus ? :debug : :warn
 
 class MQTTBridge
   def initialize(abc, homie)
@@ -67,20 +74,30 @@ class MQTTBridge
       begin
         @mutex.synchronize do
           @abc.refresh
-          @homie_abc.each do |property|
-            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
 
+          components = { @homie_abc => @abc,
+                         @blower => @abc.blower,
+                         @pump => @abc.pump }
           @abc.zones.each_with_index do |z, idx|
             homie_zone = @homie["zone#{idx + 1}"]
-            homie_zone.each do |property|
-              property.value = z.public_send(property.id.tr("-", "_"))
+            components[homie_zone] = z
+          end
+
+          components.each do |(node, object)|
+            node.each do |property|
+              property.value = object.public_send(property.id.tr("-", "_"))
             end
           end
+
+          if @abc.dhw?
+            @dhw["enabled"].value = @abc.dhw_enabled
+            @dhw["water-temperature"].value = @abc.dhw_water_temperature
+            @dhw["set-point"].value = @abc.dhw_setpoint
+          end
+
+          @abc.faults.each_with_index do |fault_count, i|
+            @faults["e#{i + 1}"].value = fault_count
+          end
         end
       rescue => e
         warn "got garbage: #{e}; #{e.backtrace}"
@@ -92,15 +109,14 @@ class MQTTBridge
 
   def publish_basic_attributes
     @homie_abc = @homie.node("abc", "Aurora Basic Control", "ABC") do |node|
-      node.property("compressor-speed", "Compressor Speed", :integer, @abc.compressor_speed, format: 0..1)
+      node.property("compressor-speed", "Compressor Speed", :integer, @abc.compressor_speed,
+                    format: @abc.vs_drive? ? 0..12 : 0..2)
       node.property("current-mode", "Current Heating/Cooling Mode", :enum, @abc.current_mode,
-                    format: %w[lockout standby blower h1 h2 c1 c2 eh1 eh2])
-      node.property("dhw-water-temperature", "DHW Water Temperature", :float, @abc.dhw_water_temperature, unit: "ºF")
+                    format: %w[lockout standby blower heating cooling eh1 eh2 emergency waiting dehumidify])
       node.property("entering-air-temperature", "Entering Air Temperature", :float, @abc.entering_air_temperature,
                     unit: "ºF")
       node.property("entering-water-temperature", "Entering Water Temperature", :float,
                     @abc.entering_water_temperature, unit: "ºF")
-      node.property("fan-speed", "Fan Speed", :integer, @abc.fan_speed, format: 0..11)
       node.property("leaving-air-temperature", "Leaving Air Temperature", :float, @abc.leaving_air_temperature,
                     unit: "ºF")
       node.property("leaving-water-temperature", "Leaving Water Temperature", :float, @abc.leaving_water_temperature,
@@ -110,22 +126,74 @@ class MQTTBridge
       end
       node.property("relative-humidity", "Relative Humidity", :integer, @abc.relative_humidity, unit: "%",
                                                                                                 format: 0..100)
-      node.property("waterflow", "Waterflow", :float, unit: "gpm")
       node.property("fp1", "FP1 Sensor", :float, @abc.fp1, unit: "ºF")
       node.property("fp2", "FP2 Sensor", :float, @abc.fp2, unit: "ºF")
-      %i[compressor blower aux_heat loop_pump total].each do |component|
+      %i[compressor aux_heat total].each do |component|
         component = "#{component}_watts"
         node.property(component.tr("_", "-"), component.tr("_", " ").titleize, :integer,
                       @abc.public_send(component), unit: "W")
       end
+    end
+
+    @blower = @homie.node("blower", "Blower", @abc.blower.type) do |node|
+      if @abc.blower.respond_to?(:running)
+        node.property("running", "Blower is running", :boolean, @abc.blower.running?)
+      else
+        node.property("speed", "Current blower speed", :integer, @abc.blower.speed, format: @abc.blower.speed_range)
+      end
+      node.property("watts", "Energy Usage", :integer, @abc.blower.watts, unit: "W") if @abc.energy_monitoring?
+
+      next unless @abc.blower.is_a?(Aurora::Blower::ECM)
 
-      node.property("blower-only-ecm-speed", "Blower Only ECM Speed", :integer, @abc.blower_only_ecm_speed,
-                    format: 1..12) do |value, property|
-        @mutex.synchronize { property.value = @abc.blower_only_ecm_speed = value }
+      presets = %w[blower-only aux-heat]
+      presets.concat %w[low-compressor high-compressor] unless @abc.iz2?
+      presets.each do |setting|
+        field = "#{setting.tr('-', '_')}_speed"
+        node.property("#{setting}-speed", "#{setting.tr('-', ' ').titleize} Preset Speed", :integer,
+                      @abc.blower.public_send(field), format: 1..12) do |value, property|
+          @mutex.synchronize { property.value = @abc.blower.public_send("#{field}=", value) }
+        end
+      end
+      if @abc.iz2?
+        node.property("iz2-desired-speed", "IZ2 Desired Speed", :integer, @abc.blower.iz2_desired_speed,
+                      format: 0..100, unit: "%")
       end
-      node.property("aux-heat-ecm-speed", "Aux Heat ECM Speed", :integer, @abc.aux_heat_ecm_speed,
-                    format: 1..12) do |value, property|
-        @mutex.synchronize { property.value = @abc.aux_heat_ecm_speed = value }
+    end
+
+    @pump = @homie.node("pump", "Loop Pump", @abc.pump.type) do |node|
+      node.property("waterflow", "Waterflow", :float, @abc.pump.waterflow, unit: "gpm")
+      node.property("watts", "Energy Usage", :integer, @abc.pump.watts, unit: "W") if @abc.energy_monitoring?
+
+      next unless @abc.pump.is_a?(Aurora::Pump::VSPump)
+
+      node.property("speed", "Speed", :integer, @abc.pump.speed, format: 0..100, unit: "%") do |value, property|
+        @mutex.synchronize { property.value = @abc.pump.speed = value }
+      end
+      node.property("manual-control", "If manual control is enabled", :boolean,
+                    @abc.pump.manual_control?) do |value, property|
+        @mutex.synchronize { property.value = @abc.pump.manual_control = value }
+      end
+      node.property("minimum-speed", "Speed pump runs at compressor speed 0", :integer, @abc.pump.minimum_speed,
+                    format: 0..100, unit: "%") do |value, property|
+        @mutex.synchronize { property.value = @abc.pump.minimum_speed = value }
+      end
+      node.property("maximum-speed", "Speed pump runs at compressor speed 12", :integer, @abc.pump.minimum_speed,
+                    format: 0..100, unit: "%") do |value, property|
+        @mutex.synchronize { property.value = @abc.pump.maximum_speed = value }
+      end
+    end
+
+    if @abc.dhw?
+      @dhw = @homie.node("dhw", "Domestic Hot Water Generator", "DHW") do |node|
+        node.property("enabled", "Enabled", :boolean, @abc.dhw_enabled) do |value, property|
+          @mutex.synchronize { property.value = @abc.dhw_enabled = value }
+        end
+        node.property("water-temperature", "DHW Water Temperature", :float,
+                      @abc.dhw_water_temperature, unit: "ºF")
+        node.property("set-point", "DHW Set Point", :float, @abc.dhw_setpoint, format: 100..140,
+                                                                               unit: "ºF") do |value, property|
+          @mutex.synchronize { property.value = @abc.dhw_setpoint = value }
+        end
       end
     end
 
@@ -191,7 +259,7 @@ end
 log_level = ARGV.include?("--debug") ? :debug : :warn
 logger = Logger.new($stdout)
 logger.level = log_level
-slave.logger = logger
+abc.modbus_slave.logger = logger
 
 device = "aurora-#{abc.serial_number}"
 homie = MQTT::Homie::Device.new(device, "Aurora MQTT Bridge", mqtt: mqtt_uri)

data/exe/web_aid_tool

@@ -7,17 +7,13 @@ require "logger"
 require "optparse"
 require "yaml"
 
-debug_modbus = monitor = mock = false
+debug_modbus = monitor = 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("--monitor", "Print interpreted registers as they are requested, like aurora_monitor") { monitor = true }
   opts.on("-h", "--help", "Prints this help") do
     puts opts
     exit
@@ -31,51 +27,9 @@ unless ARGV.length == 1
   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
+slave = Aurora::ABCClient.open_modbus_slave(ARGV[0])
+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
@@ -89,6 +43,7 @@ end
 require "sinatra"
 
 set :public_folder, "html"
+set :logging, false
 
 get "/" do
   send_file "html/index.htm"
@@ -138,7 +93,10 @@ get "/request.cgi" do
       start...(start + length)
     end
     registers = slave.read_multiple_holding_registers(*queries)
-    puts Aurora.print_registers(registers) if monitor
+    if monitor
+      puts "READING"
+      puts Aurora.print_registers(registers)
+    end
     result["values"] = registers.values.join(",")
   when "putregs"
     writes = params["regs"].split(";").map do |write|
@@ -147,7 +105,6 @@ get "/request.cgi" do
     if monitor
       puts "WRITING"
       puts Aurora.print_registers(writes)
-      puts "==="
     end
 
     writes.each do |(addr, value)|