waterfurnace_aurora 0.2.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bbf110fc6004aa69327e04b6a778fb2b59db4357cbd4c9f519805b581a2d505
-  data.tar.gz: dc95dcbaa26625f59b3822adae5c1e1e0dc38483df90d8ba10b5f417824d845f
+  metadata.gz: 47ba3e76677f00093692ed3f75daac6629fc77c71102a200efe88a846d271045
+  data.tar.gz: 6183cec3c273fafa6eb529e3e9fb0c6769941a51bd22d808528ffbd0f75b3fad
 SHA512:
-  metadata.gz: f82a6d294a7643c0cfcc504a7e78f3eced539579d950d70f2ceb66f144891af71269c05c2cdffa2c505ae03175220317cd0b3cfffcedc092e1b3d014ede2a847
-  data.tar.gz: 486d293ef3021d2c0342cfaa4a7286eef0e7e0854cbaa79be1d453c274d492f94c2bb78ae920bf6442ccc7c90b4b4cae416b67d0ccb9ca3d9c539fcd8c890497
+  metadata.gz: 6a961b2e49137c51cb888f0bf3a551c530be8eed02cc9fc978c38ab0ef3b00c582b90c1d44466f126f90bed0934632b22fe976166b3c59ded871b61b2ee6202c
+  data.tar.gz: f275fe6dce4542e0212abd90b7346c7e6970e23af7b657bc4c05ed3dd9682b36ad87e68abcbf03644e5fff62af89d2149edc0aa16605f33021734a52c81ca263

data/exe/aurora_monitor

@@ -3,11 +3,38 @@
 
 require "aurora"
 require "ccutrer-serialport"
+require "optparse"
 require "socket"
 require "uri"
 
+diff_only = debug_modbus = ignore_awl_heartbeat = ignore_sensors = false
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: aurora_monitor /path/to/serial/port [options]"
+
+  opts.on("-q", "--quiet",
+          "Enables quiet mode (--diff-only, --ignore-awl-heartbeat, --ignore-sensors) to ease in deciphering new registers") do # rubocop:disable Layout/LineLength
+    diff_only = true
+    ignore_awl_heartbeat = true
+    ignore_sensors = true
+  end
+  opts.on("--diff-only", "Only show registers if they've changed from their previous value") { diff_only = true }
+  opts.on("--debug-modbus", "Print actual protocol bytes") { debug_modbus = true }
+  opts.on("--ignore-awl-heartbeat", "Don't print AWL heartbeat requests") { ignore_awl_heartbeat = true }
+  opts.on("--ignore-sensors", "Don't print sensor registers (i.e. because they change a lot)") { ignore_sensors = true }
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+end.parse!
+
 uri = URI.parse(ARGV[0])
 
+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 = if uri.scheme == "telnet" || uri.scheme == "rfc2217"
          require "net/telnet/rfc2217"
          [Net::Telnet::RFC2217.new("Host" => uri.host,
@@ -20,23 +47,38 @@ args = if uri.scheme == "telnet" || uri.scheme == "rfc2217"
 
 server = ModBus::RTUServer.new(*args)
 server.promiscuous = true
-server.debug = true
+server.debug = debug_modbus
+
+diff_and_print = lambda do |registers|
+  registers = registers.slice(*(registers.keys - SENSOR_REGISTERS)) if ignore_sensors
+  next puts Aurora.print_registers(registers) unless diff_only
+
+  new_registers = last_registers.merge(registers)
+  diff = Aurora.diff_registers(last_registers, new_registers)
+  unless diff.empty?
+    puts "#{Time.now} ===== read"
+    puts Aurora.print_registers(diff)
+  end
+  last_registers = new_registers
+end
 
 server.request_callback = lambda { |uid, func, req|
   if func == 68
-    puts "===== no idea to #{uid}: #{req.inspect}"
+    puts "#{Time.now} ===== no idea to #{uid}: #{req.inspect}" unless diff_only
   elsif func == 67
-    puts "===== write discontiguous registers to #{uid}:"
+    puts "#{Time.now} ===== write discontiguous registers to #{uid}:"
     registers = req.map { |p| [p[:addr], p[:val]] }.to_h
     puts Aurora.print_registers(registers)
   elsif func == 16
-    puts "===== write multiple registers to #{uid}:"
     registers = Range.new(req[:addr], req[:addr] + req[:quant] - 1).zip(req[:val]).to_h
+    next if ignore_awl_heartbeat && registers == { 460 => 102, 461 => 0, 462 => 5 }
+
+    puts "#{Time.now} ===== write multiple registers to #{uid}:"
     puts Aurora.print_registers(registers)
   elsif [3, 65, 66].include?(func)
     # no output
   else
-    puts "**** new func #{func}"
+    puts "#{Time.now} **** new func #{func}"
   end
 }
 
@@ -46,9 +88,9 @@ server.response_callback = lambda { |uid, func, res, req|
       puts "wrong number of results"
       next
     end
-    puts "===== read registers from #{uid}"
+    puts "#{Time.now} ===== read registers from #{uid}" unless diff_only
     registers = Range.new(req[:addr], req[:addr] + req[:quant], true).to_a.zip(res).to_h
-    puts Aurora.print_registers(registers)
+    diff_and_print.call(registers)
   elsif func == 65 && res.is_a?(Array) && req
     register_list = []
     req.each { |params| register_list.concat(Range.new(params[:addr], params[:addr] + params[:quant], true).to_a) }
@@ -56,24 +98,23 @@ server.response_callback = lambda { |uid, func, res, req|
       puts "wrong number of results"
       next
     end
-    puts "===== read multiple register ranges from #{uid}"
+    puts "#{Time.now} ===== read multiple register ranges from #{uid}" unless diff_only
     result = register_list.zip(res).to_h
-    puts Aurora.print_registers(result)
+    diff_and_print.call(result)
   elsif func == 66 && res.is_a?(Array) && req
     unless req.length == res.length
       puts "wrong number of results"
       next
     end
-    puts "===== read discontiguous registers from #{uid}"
+    puts "#{Time.now} ===== read discontiguous registers from #{uid}" unless diff_only
     registers = req.zip(res).to_h
-    puts Aurora.print_registers(registers)
+    diff_and_print.call(registers)
   elsif [16, 67, 68].include?(func)
     # no output
   else
-    puts "**** new func #{func}"
+    puts "#{Time.now} **** new func #{func}"
   end
 }
 
-require "byebug"
 server.send(:serve, server.instance_variable_get(:@sp))
 loop { nil }

data/exe/aurora_mqtt_bridge

@@ -5,6 +5,7 @@ require "aurora"
 require "homie-mqtt"
 require "ccutrer-serialport"
 require "uri"
+require "aurora/core_ext/string"
 
 uri = URI.parse(ARGV[0])
 mqtt_uri = ARGV[1]
@@ -28,7 +29,7 @@ class MQTTBridge
     @homie = homie
     @mutex = Mutex.new
 
-    @homie.instance_variable_set(:@block, lambda do |topic, value|
+    @homie.out_of_band_topic_proc = lambda do |topic, value|
       @mutex.synchronize do
         case topic
         when /\$modbus$/
@@ -48,7 +49,7 @@ class MQTTBridge
             registers.merge!(@abc.modbus_slave.read_multiple_holding_registers(*subquery))
           end
           result = Aurora.print_registers(registers)
-          @homie.mqtt.publish("#{@home.topic}/$modbus/response", result, retain: false, qos: 1)
+          @homie.mqtt.publish("#{@homie.topic}/$modbus/response", result, retain: false, qos: 1)
         when %r{\$modbus/(\d+)$}
           register = Regexp.last_match(1).to_i
           value = case value
@@ -61,47 +62,46 @@ class MQTTBridge
         end
       end
     rescue StandardError => e
-      puts "failed processing message: #{e}\n#{e.backtrace}"
-    end)
+      logger.error("failed processing message: #{e}\n#{e.backtrace}")
+    end
 
+    @abc.refresh
     publish_basic_attributes
 
     loop do
       begin
         @mutex.synchronize do
           @abc.refresh
-          @homie_abc["compressor-speed"].value = @abc.compressor_speed
-          @homie_abc["current-mode"].value = @abc.current_mode
-          @homie_abc["dhw-water-temperature"].value = @abc.dhw_water_temperature
-          @homie_abc["entering-air-temperature"].value = @abc.entering_air_temperature
-          @homie_abc["entering-water-temperature"].value = @abc.entering_water_temperature
-          @homie_abc["fan-speed"].value = @abc.fan_speed
-          @homie_abc["leaving-air-temperature"].value = @abc.leaving_air_temperature
-          @homie_abc["leaving-water-temperature"].value = @abc.leaving_water_temperature
-          @homie_abc["outdoor-temperature"].value = @abc.outdoor_temperature
-          @homie_abc["relative-humidity"].value = @abc.relative_humidity
-          @homie_abc["waterflow"].value = @abc.waterflow
-          @homie_abc["fp1"].value = @abc.fp1
-          @homie_abc["fp2"].value = @abc.fp2
+          %i[compressor_speed
+             current_mode
+             dhw_water_temperature
+             entering_air_temperature
+             entering_water_temperature
+             fan_speed
+             leaving_air_temperature
+             leaving_water_temperature
+             outdoor_temperature
+             relative_humidity
+             waterflow
+             fp1
+             fp2
+             compressor_watts
+             blower_watts
+             aux_heat_watts
+             loop_pump_watts
+             total_watts].each do |property|
+            @homie_abc[property.to_s.tr("_", "-")].value = @abc.public_send(property)
+          end
 
-          @abc.iz2_zones.each do |z|
-            homie_zone = @homie["zone#{z.zone_number}"]
-            homie_zone["target-mode"].value = z.target_mode
-            homie_zone["current-mode"].value = z.current_mode
-            homie_zone["target-fan-mode"].value = z.target_fan_mode
-            homie_zone["current-fan-mode"].value = z.current_fan_mode
-            homie_zone["fan-intermittent-on"].value = z.fan_intermittent_on
-            homie_zone["fan-intermittent-off"].value = z.fan_intermittent_off
-            homie_zone["priority"].value = z.priority
-            homie_zone["size"].value = z.size
-            homie_zone["normalized-size"].value = z.normalized_size
-            homie_zone["ambient-temperature"].value = z.ambient_temperature
-            homie_zone["heating-target-temperature"].value = z.heating_target_temperature
-            homie_zone["cooling-target-temperature"].value = z.cooling_target_temperature
+          @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("-", "_"))
+            end
           end
         end
       rescue => e
-        puts "got garbage: #{e}; #{e.backtrace}"
+        logger.error("got garbage: #{e}; #{e.backtrace}")
         exit 1
       end
       sleep(5)
@@ -129,34 +129,46 @@ class MQTTBridge
       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|
+        component = "#{component}_watts"
+        node.property(component.tr("_", "-"), component.tr("_", " ").titleize, :integer,
+                      @abc.public_send(component), unit: "W")
+      end
     end
 
-    @abc.iz2_zones.each do |zone|
-      @homie.node("zone#{zone.zone_number}", "Zone #{zone.zone_number}", "IntelliZone 2 Zone") do |node|
+    @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|
         allowed_modes = %w[off auto cool heat]
-        allowed_modes << "eheat" if zone.zone_number == 1
+        allowed_modes << "eheat" if i.zero?
         node.property("target-mode", "Target Heating/Cooling Mode", :enum, zone.target_mode,
                       format: allowed_modes) do |value, property|
           @mutex.synchronize { property.value = zone.target_mode = value.to_sym }
         end
-        node.property("current-mode", "Current Heating/Cooling Mode Requested", :enum, zone.current_mode,
-                      format: %w[standby h1 h2 h3 c1 c2])
-        node.property("target-fan-mode", "Target Fan Mode", :enum,  zone.target_fan_mode,
+        if zone.respond_to?(:current_mode) # TODO: implement for non-IZ2
+          node.property("current-mode", "Current Heating/Cooling Mode Requested", :enum, zone.current_mode,
+                        format: %w[standby h1 h2 h3 c1 c2])
+        end
+        node.property("target-fan-mode", "Target Fan Mode", :enum, zone.target_fan_mode,
                       format: %w[auto continuous intermittent]) do |value, property|
           @mutex.synchronize { property.value = zone.target_fan_mode = value.to_sym }
         end
-        node.property("current-fan-mode", "Current Fan Status", :boolean, zone.current_fan_mode)
-        node.property("fan-intermittent-on", "Fan Intermittent Mode On Duration", :enum, zone.fan_intermittent_on,
-                      unit: "M", format: %w[0 5 10 15 20]) do |value, property|
-          @mutex.synchronize { property.value = zone.fan_intermittent_on = value.to_i }
+        if zone.respond_to?(:current_fan_mode) # TODO: implement for non-IZ2
+          node.property("current-fan-mode", "Current Fan Status", :boolean, zone.current_fan_mode)
+          node.property("fan-intermittent-on", "Fan Intermittent Mode On Duration", :enum, zone.fan_intermittent_on,
+                        unit: "M", format: %w[0 5 10 15 20]) do |value, property|
+            @mutex.synchronize { property.value = zone.fan_intermittent_on = value.to_i }
+          end
+          node.property("fan-intermittent-off", "Fan Intermittent Mode Off Duration", :enum, zone.fan_intermittent_on,
+                        unit: "M", format: %w[0 5 10 15 20 25 30 35 40]) do |value, property|
+            @mutex.synchronize { property.value = zone.fan_intermittent_on = value.to_i }
+          end
         end
-        node.property("fan-intermittent-off", "Fan Intermittent Mode Off Duration", :enum, zone.fan_intermittent_on,
-                      unit: "M", format: %w[0 5 10 15 20 25 30 35 40]) do |value, property|
-          @mutex.synchronize { property.value = zone.fan_intermittent_on = value.to_i }
+        if zone.is_a?(Aurora::IZ2Zone)
+          node.property("priority", "Zone Priority", :enum, zone.priority, format: %w[economy comfort])
+          node.property("size", "Size", :enum, zone.size, format: %w[0 25 45 70])
+          node.property("normalized-size", "Normalized Size", :integer, zone.normalized_size, unit: "%", format: 0..100)
         end
-        node.property("priority", "Zone Priority", :enum, zone.priority, format: %w[economy comfort])
-        node.property("size", "Size", :enum, zone.size, format: %w[0 25 45 70])
-        node.property("normalized-size", "Normalized Size", :integer, zone.normalized_size, unit: "%", format: 0..100)
         node.property("ambient-temperature", "Ambient Temperature", :float, zone.ambient_temperature, unit: "ºF")
         node.property("heating-target-temperature", "Heating Target Temperature", :integer,
                       zone.heating_target_temperature, unit: "ºF", format: 40..90) do |value, property|
@@ -176,4 +188,13 @@ class MQTTBridge
   end
 end
 
-MQTTBridge.new(abc, MQTT::Homie::Device.new("aurora", "Aurora MQTT Bridge", mqtt: mqtt_uri))
+log_level = ARGV.include?("--debug") ? :debug : :warn
+logger = Logger.new($stdout)
+logger.level = log_level
+slave.logger = logger
+
+device = "aurora-#{abc.serial_number}"
+homie = MQTT::Homie::Device.new(device, "Aurora MQTT Bridge", mqtt: mqtt_uri)
+homie.logger = logger
+
+MQTTBridge.new(abc, homie)

data/lib/aurora/abc_client.rb

@@ -3,7 +3,8 @@
 module Aurora
   class ABCClient
     attr_reader :modbus_slave,
-                :iz2_zones,
+                :serial_number,
+                :zones,
                 :current_mode,
                 :fan_speed,
                 :entering_air_temperature,
@@ -16,26 +17,42 @@ module Aurora
                 :compressor_speed,
                 :outdoor_temperature,
                 :fp1,
-                :fp2
+                :fp2,
+                :compressor_watts,
+                :blower_watts,
+                :aux_heat_watts,
+                :loop_pump_watts,
+                :total_watts
 
     def initialize(modbus_slave)
       @modbus_slave = modbus_slave
       @modbus_slave.read_retry_timeout = 15
       @modbus_slave.read_retries = 2
+      registers_array = @modbus_slave.holding_registers[105...110]
+      registers = registers_array.each_with_index.map { |r, i| [i + 105, r] }.to_h
+      @serial_number = Aurora.transform_registers(registers)[105]
       iz2_zone_count = @modbus_slave.holding_registers[483]
-      @iz2_zones = (0...iz2_zone_count).map { |i| IZ2Zone.new(self, i + 1) }
+      # TODO: better detect IZ2/Non-IZ2
+      @zones = if iz2_zone_count > 1
+                 (0...iz2_zone_count).map { |i| IZ2Zone.new(self, i + 1) }
+               else
+                 [Thermostat.new(self)]
+               end
     end
 
     def refresh
-      registers_to_read = [19..20, 30, 344, 740..741, 900, 1110..1111, 1114, 1117, 3027, 31_003]
-      # IZ2 zones
-      iz2_zones.each_with_index do |_z, i|
-        base1 = 21_203 + i * 9
-        base2 = 31_007 + i * 3
-        base3 = 31_200 + i * 3
-        registers_to_read << (base1..(base1 + 1))
-        registers_to_read << (base2..(base2 + 2))
-        registers_to_read << base3
+      registers_to_read = [19..20, 30, 344, 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
+          base2 = 31_007 + i * 3
+          base3 = 31_200 + i * 3
+          registers_to_read << (base1..(base1 + 1))
+          registers_to_read << (base2..(base2 + 2))
+          registers_to_read << base3
+        end
+      else
+        registers_to_read << 745..747
       end
 
       registers = @modbus_slave.holding_registers[*registers_to_read]
@@ -54,6 +71,11 @@ module Aurora
       @fp1                        = registers[19]
       @fp2                        = registers[20]
       @locked_out                 = registers[1117]
+      @compressor_watts           = registers[1147]
+      @blower_watts               = registers[1149]
+      @aux_heat_watts             = registers[1151]
+      @loop_pump_watts            = registers[1165]
+      @total_watts                = registers[1153]
 
       outputs = registers[30]
       @current_mode = if outputs.include?(:lockout)
@@ -72,7 +94,7 @@ module Aurora
                         :standby
                       end
 
-      iz2_zones.each do |z|
+      zones.each do |z|
         z.refresh(registers)
       end
     end

data/lib/aurora/core_ext/string.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Aurora
+  module Inflector
+    def titleize
+      gsub(/\b(?<!\w['â`])[a-z]/, &:capitalize)
+    end
+  end
+end
+String.include(Aurora::Inflector)

data/lib/aurora/iz2_zone.rb

@@ -1,22 +1,19 @@
 # frozen_string_literal: true
 
+require "aurora/thermostat"
+
 module Aurora
-  class IZ2Zone
+  class IZ2Zone < Thermostat
     attr_reader :zone_number,
-                :target_mode,
                 :current_mode,
-                :target_fan_mode,
                 :current_fan_mode,
                 :fan_intermittent_on,
                 :fan_intermittent_off,
                 :priority,
-                :size, :normalized_size,
-                :ambient_temperature,
-                :cooling_target_temperature,
-                :heating_target_temperature
+                :size, :normalized_size
 
     def initialize(abc, zone_number)
-      @abc = abc
+      super(abc)
       @zone_number = zone_number
     end
 
@@ -42,68 +39,47 @@ module Aurora
     end
 
     def target_mode=(value)
-      value = Aurora::HEATING_MODE.invert[value]
-      return unless value
+      return unless (raw_value = Aurora::HEATING_MODE.invert[value])
 
-      @abc.modbus_slave.holding_registers[21_202 + (zone_number - 1) * 9] = value
-      @target_mode = Aurora::HEATING_MODE[@abc.modbus_slave.holding_registers[21_202 + (zone_number - 1) * 9]]
+      @abc.modbus_slave.holding_registers[21_202 + (zone_number - 1) * 9] = raw_value
+      @target_mode = value
     end
 
     def target_fan_mode=(value)
-      value = Aurora::FAN_MODE.invert[value]
-      return unless value
+      return unless (raw_value = Aurora::FAN_MODE.invert[value])
 
-      @abc.modbus_slave.holding_registers[21_205 + (zone_number - 1) * 9] = value
-      registers = @abc.modbus_slave.read_multiple_holding_registers(31_008 + (zone_number - 1) * 3)
-      Aurora.transform_registers(registers)
-      @target_fan_mode = registers.first.last[:fan]
+      @abc.modbus_slave.holding_registers[21_205 + (zone_number - 1) * 9] = raw_value
+      @target_fan_mode = value
     end
 
     def fan_intermittent_on=(value)
       return unless value >= 0 && value <= 25 && (value % 5).zero?
 
       @abc.modbus_slave.holding_registers[21_206 + (zone_number - 1) * 9] = value
-      registers = @abc.modbus_slave.read_multiple_holding_registers(31_008 + (zone_number - 1) * 3)
-      Aurora.transform_registers(registers)
-      @fan_intermittent_on = registers.first.last[:on_time]
+      @fan_intermittent_on = value
     end
 
     def fan_intermittent_off=(value)
       return unless value >= 0 && value <= 40 && (value % 5).zero?
 
       @abc.modbus_slave.holding_registers[21_207 + (zone_number - 1) * 9] = value
-      registers = @abc.modbus_slave.read_multiple_holding_registers(31_008 + (zone_number - 1) * 3)
-      Aurora.transform_registers(registers)
-      @fan_intermittent_on = registers.first.last[:off_time]
+      @fan_intermittent_off = value
     end
 
     def heating_target_temperature=(value)
       return unless value >= 40 && value <= 90
 
-      value = (value * 10).to_i
-      @abc.modbus_slave.holding_registers[21_203 + (zone_number - 1) * 9] = value
-
-      base = 31_008 + (zone_number - 1) * 3
-      registers = @abc.modbus_slave.read_multiple_holding_registers(base..(base + 1))
-      Aurora.transform_registers(registers)
-      registers[base + 1][:heating_target_temperature]
+      raw_value = (value * 10).to_i
+      @abc.modbus_slave.holding_registers[21_203 + (zone_number - 1) * 9] = raw_value
+      @heating_target_temperature = value
     end
 
     def cooling_target_temperature=(value)
       return unless value >= 54 && value <= 99
 
-      value = (value * 10).to_i
+      raw_value = (value * 10).to_i
       @abc.modbus_slave.holding_registers[21_204 + (zone_number - 1) * 9] = value
-
-      registers = @abc.modbus_slave.read_multiple_holding_registers(31_008 + (zone_number - 1) * 3)
-      Aurora.transform_registers(registers)
-      registers.first.last[:cooling_target_temperature]
-    end
-
-    def inspect
-      "#<Aurora::IZ2Zone #{(instance_variables - [:@abc]).map do |iv|
-                             "#{iv}=#{instance_variable_get(iv).inspect}"
-                           end.join(', ')}>"
+      @cooling_target_temperature = raw_value
     end
   end
 end

data/lib/aurora/modbus/slave.rb

@@ -17,7 +17,7 @@ module Aurora
       end
 
       def holding_registers
-        WFProxy.new(self, :holding_register)
+        @holding_registers ||= WFProxy.new(self, :holding_register)
       end
     end
 
@@ -33,7 +33,6 @@ module Aurora
       def read_rtu_response(io)
         # Read the slave_id and function code
         msg = read(io, 2)
-        log logging_bytes(msg)
 
         function_code = msg.getbyte(1)
         case function_code

data/lib/aurora/registers.rb

@@ -52,7 +52,6 @@ module Aurora
   end
 
   def to_string(registers, idx, length)
-    puts "converting #{idx} of length #{length}"
     (idx...(idx + length)).map do |i|
       (registers[i] >> 8).chr + (registers[i] & 0xff).chr
     end.join.sub(/[ \0]+$/, "")
@@ -323,7 +322,8 @@ module Aurora
   REGISTER_CONVERTERS = {
     TO_HUNDREDTHS => [2, 3, 807, 813, 816, 817, 819, 820, 825, 828],
     method(:dipswitch_settings) => [4, 33],
-    TO_TENTHS => [19, 20, 401, 567, 740, 745, 746, 900, 1105, 1106, 1107, 1108, 1110, 1111, 1114, 1117, 1134, 1136,
+    TO_TENTHS => [19, 20, 401, 567, 740, 745, 746, 747, 900, 1105, 1106, 1107, 1108, 1110, 1111, 1114, 1117, 1134, 1136,
+                  12_619, 12_620,
                   21_203, 21_204,
                   21_212, 21_213,
                   21_221, 21_222,
@@ -348,8 +348,8 @@ module Aurora
     ->(v) { from_bitmask(v, AXB_INPUTS) } => [1103],
     ->(v) { from_bitmask(v, AXB_OUTPUTS) } => [1104],
     ->(v) { TO_TENTHS.call(NEGATABLE.call(v)) } => [1136],
-    ->(v) { HEATING_MODE[v] } => [21_202, 21_211, 21_220, 21_229, 21_238, 21_247],
-    ->(v) { FAN_MODE[v] } => [21_205, 21_214, 21_223, 21_232, 21_241, 21_250],
+    ->(v) { HEATING_MODE[v] } => [12_602, 21_202, 21_211, 21_220, 21_229, 21_238, 21_247],
+    ->(v) { FAN_MODE[v] } => [12_621, 21_205, 21_214, 21_223, 21_232, 21_241, 21_250],
     ->(v) { from_bitmask(v, HUMIDIFIER_SETTINGS) } => [31_109],
     ->(v) { { humidification_target: v >> 8, dehumidification_target: v & 0xff } } => [31_110],
     method(:iz2_demand) => [31_005],
@@ -367,7 +367,8 @@ module Aurora
   REGISTER_FORMATS = {
     "%ds" => [1, 6, 9, 15, 84, 85],
     "%dV" => [16, 112],
-    "%0.1fºF" => [19, 20, 401, 567, 740, 745, 746, 900, 1110, 1111, 1114, 1134, 1136,
+    "%0.1fºF" => [19, 20, 401, 567, 740, 745, 746, 747, 900, 1110, 1111, 1114, 1134, 1136,
+                  12_619, 12_620,
                   21_203, 21_204,
                   21_212, 21_213,
                   21_221, 21_222,
@@ -398,7 +399,7 @@ module Aurora
       base2 = 31_007 + (i - 1) * 3
       base3 = 31_200 + (i - 1) * 3
       {
-        base1 => "Zone #{i} Heating Mode",
+        base1 => "Zone #{i} Heating Mode (write)",
         (base1 + 1) => "Zone #{i} Heating Setpoint (write)",
         (base1 + 2) => "Zone #{i} Cooling Setpoint (write)",
         (base1 + 3) => "Zone #{i} Fan Mode (write)",
@@ -493,25 +494,6 @@ module Aurora
     61_000..61_009
   ].freeze
 
-  def read_all_registers(modbus_slave)
-    result = []
-    REGISTER_RANGES.each do |range|
-      # read at most 100 at a time
-      range.each_slice(100) do |keys|
-        result.concat(modbus_slave.holding_registers[keys.first..keys.last])
-      end
-    end
-    REGISTER_RANGES.map(&:to_a).flatten.zip(result).to_h
-  end
-
-  def diff_registers(lhs, rhs)
-    diff = {}
-    lhs.each_key do |k|
-      diff[k] = [lhs[k], rhs[k]] if lhs[k] != rhs[k]
-    end
-    diff
-  end
-
   REGISTER_NAMES = {
     1 => "Random Start Delay",
     2 => "ABC Program Version",
@@ -579,6 +561,7 @@ module Aurora
     741 => "Relative Humidity",
     745 => "Heating Set Point",
     746 => "Cooling Set Point",
+    747 => "Ambient Temperature",
     807 => "AXB Version",
     813 => "IZ2 Version?",
     816 => "AOC Version 1?",
@@ -607,6 +590,10 @@ module Aurora
     1153 => "Total Watts",
     1157 => "Ht of Rej",
     1165 => "VS Pump Watts",
+    12_602 => "Heating Mode (write)",
+    12_619 => "Heating Setpoint (write)",
+    12_620 => "Cooling Setpoint (write)",
+    12_621 => "Fan Mode (write)",
     3027 => "Compressor Speed",
     31_003 => "Outdoor Temp",
     31_005 => "IZ2 Demand",
@@ -641,6 +628,25 @@ module Aurora
     registers
   end
 
+  def read_all_registers(modbus_slave)
+    result = []
+    REGISTER_RANGES.each do |range|
+      # read at most 100 at a time
+      range.each_slice(100) do |keys|
+        result.concat(modbus_slave.holding_registers[keys.first..keys.last])
+      end
+    end
+    REGISTER_RANGES.map(&:to_a).flatten.zip(result).to_h
+  end
+
+  def diff_registers(lhs, rhs)
+    diff = {}
+    (lhs.keys | rhs.keys).each do |k|
+      diff[k] = rhs[k] if lhs[k] != rhs[k]
+    end
+    diff
+  end
+
   def print_registers(registers)
     result = []
     registers.each do |(k, value)|
@@ -648,15 +654,17 @@ module Aurora
       next if REGISTER_NAMES.key?(k) && REGISTER_NAMES[k].nil?
 
       name = REGISTER_NAMES[k]
+
       value_proc = REGISTER_CONVERTERS.find { |(_, z)| z.include?(k) }&.first || ->(v) { v }
       format = REGISTER_FORMATS.find { |(_, z)| z.include?(k) }&.first || "%s"
       format = "%1$d (0x%1$04x)" unless name
-      name ||= "???"
 
       value = value_proc.arity == 2 ? value_proc.call(registers, k) : value_proc.call(value)
       value = value.join(", ") if value.is_a?(Array)
       value = format(format, value) if value
 
+      name ||= "???"
+
       result << "#{name} (#{k}): #{value}"
     end
     result.join("\n")

data/lib/aurora/thermostat.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Aurora
+  class Thermostat
+    attr_reader :target_mode,
+                :target_fan_mode,
+                :ambient_temperature,
+                :cooling_target_temperature,
+                :heating_target_temperature
+
+    def initialize(abc)
+      @abc = abc
+    end
+
+    def refresh(registers)
+      @ambient_temperature = registers[747]
+      @heating_target_temperature = registers[746]
+      @cooling_target_temperature = registers[745]
+    end
+
+    def target_mode=(value)
+      return unless (raw_value = HEATING_MODE.invert[value])
+
+      @abc.modbus_slave.holding_registers[12_602] = raw_value
+      @target_mode = value
+    end
+
+    def target_fan_mode=(value)
+      return unless (raw_value = FAN_MODE.invert[value])
+
+      @abc.modbus_slave.holding_registers[12_621] = raw_value
+      @target_fan_mode = value
+    end
+
+    def heating_target_temperature=(value)
+      return unless value >= 40 && value <= 90
+
+      raw_value = (value * 10).to_i
+      @abc.modbus_slave.holding_registers[12_619] = raw_value
+      @heating_target_temperature = value
+    end
+
+    def cooling_target_temperature=(value)
+      return unless value >= 54 && value <= 99
+
+      raw_value = (value * 10).to_i
+      @abc.modbus_slave.holding_registers[12_620] = raw_value
+      @cooling_target_temperature = value
+    end
+
+    def inspect
+      "#<Aurora::#{self.class.name} #{(instance_variables - [:@abc]).map do |iv|
+                                        "#{iv}=#{instance_variable_get(iv).inspect}"
+                                      end.join(', ')}>"
+    end
+  end
+end

data/lib/aurora/version.rb

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

data/lib/aurora.rb

@@ -4,6 +4,7 @@ require "rmodbus"
 
 require "aurora/abc_client"
 require "aurora/iz2_zone"
+require "aurora/thermostat"
 require "aurora/modbus/server"
 require "aurora/modbus/slave"
 require "aurora/registers"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: waterfurnace_aurora
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-23 00:00:00.000000000 Z
+date: 2021-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ccutrer-serialport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: 1.4.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: 1.4.4
 - !ruby/object:Gem::Dependency
   name: net-telnet-rfc2217
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -125,10 +125,12 @@ files:
 - exe/registers.yml
 - lib/aurora.rb
 - lib/aurora/abc_client.rb
+- lib/aurora/core_ext/string.rb
 - lib/aurora/iz2_zone.rb
 - lib/aurora/modbus/server.rb
 - lib/aurora/modbus/slave.rb
 - lib/aurora/registers.rb
+- lib/aurora/thermostat.rb
 - lib/aurora/version.rb
 - lib/waterfurnace_aurora.rb
 homepage: https://github.com/ccutrer/waterfurnace