waterfurnace_aurora 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc02021d49b86596b6f1d40c244b3e3671280c578cc9cd869fc936f2c219a0bf
-  data.tar.gz: 795aa42ff626534a4750eb181e5299f82d0603f677a6b9d1fb2d8418046643c6
+  metadata.gz: 874cdb2301677f41dcae609df8e59651bb875a2f537bb6afa6f66cd2a3a38f1f
+  data.tar.gz: 1bda4a259f0989eb7bdff05feac18a9f75a1679edffe1ffe220e5ca3f0bbad32
 SHA512:
-  metadata.gz: 978a3a910d919a85a79f1d272ecec65b68908472492e25dcc8f7bc8f1ddc414f82ef1c22268e092ce026c0dbb90f48c73e9ede9f30144df3f2978fb5abf70b6b
-  data.tar.gz: 93336e684ab033ca48539738634e8835deffaac4fb5c7275269086e21a134f1f5ad2793c4ae859a806c385dec88811ed720ec837dda0c5f7cd4a068e24cb3338
+  metadata.gz: a7bb6b496cf370651f22292b225a72113ad390ebbfcfada985d6d7b3bd5d50b84f9d61b89053e2cd80159abd083adfbc14a90dcb183326048f002b941763e348
+  data.tar.gz: 31d6afb25c7df8ccef66da014605bc8a04618cd5b99377ce54462814000b134eb4486554d94bd9b25ef098e3dad07f38617533d0cdcfb4ad0b015070f7667b02

data/exe/aurora_fetch

@@ -15,6 +15,10 @@ options = OptionParser.new do |opts|
 
   opts.on("--debug-modbus", "Print actual protocol bytes") { debug_modbus = true }
   opts.on("-y", "--yaml", "Output raw values as YAML") { yaml = true }
+  opts.on("-v", "--version", "Print version") do
+    puts Aurora::VERSION
+    exit
+  end
   opts.on("-h", "--help", "Prints this help") do
     puts opts
     exit

data/exe/aurora_mock

@@ -38,7 +38,7 @@ r = slave1.holding_registers = slave2.holding_registers = slave255.holding_regis
 registers = YAML.safe_load(File.read(ARGV[2]))
 registers.each { |(k, v)| r[k] = v }
 
-server1.request_callback = lambda { |uid, func, req|
+server1.request_callback = lambda do |uid, func, req|
   if func == 68
     puts "===== no idea to #{uid}: #{req.inspect}"
   elsif func == 67
@@ -54,9 +54,9 @@ server1.request_callback = lambda { |uid, func, req|
   else
     puts "**** new func #{func}"
   end
-}
+end
 
-server1.response_callback = lambda { |uid, func, res, req|
+server1.response_callback = lambda do |uid, func, res, req|
   if func == 3 && res.is_a?(Array) && req
     unless req[:quant] == res.length
       puts "wrong number of results"
@@ -88,7 +88,7 @@ server1.response_callback = lambda { |uid, func, res, req|
   else
     puts "**** new func #{func}"
   end
-}
+end
 
 server2.start
 server1.send(:serve, server1.instance_variable_get(:@sp))

data/exe/aurora_monitor

@@ -22,6 +22,10 @@ options = OptionParser.new do |opts|
   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("-v", "--version", "Print version") do
+    puts Aurora::VERSION
+    exit
+  end
   opts.on("-h", "--help", "Prints this help") do
     puts opts
     exit
@@ -75,7 +79,7 @@ diff_and_print = lambda do |registers|
   last_registers = new_registers
 end
 
-server.request_callback = lambda { |uid, func, req|
+server.request_callback = lambda do |uid, func, req|
   if func == 6
     puts "#{Time.now} ===== write register to #{uid}:"
     registers = { req[:addr] => req[:val] }
@@ -100,9 +104,9 @@ server.request_callback = lambda { |uid, func, req|
   else
     puts "#{Time.now} **** new func #{func}"
   end
-}
+end
 
-server.response_callback = lambda { |uid, func, res, req|
+server.response_callback = lambda do |uid, func, res, req|
   if func == 3 && res.is_a?(Array) && req
     unless req[:quant] == res.length
       puts "wrong number of results"
@@ -134,7 +138,7 @@ server.response_callback = lambda { |uid, func, res, req|
   else
     puts "#{Time.now} **** new func #{func}"
   end
-}
+end
 
 server.send(:serve, server.instance_variable_get(:@sp))
 loop { nil }

data/exe/aurora_mqtt_bridge

@@ -3,6 +3,7 @@
 
 require "aurora"
 require "homie-mqtt"
+require "mqtt/home_assistant"
 require "ccutrer-serialport"
 require "uri"
 require "optparse"
@@ -15,6 +16,10 @@ 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("-v", "--version", "Print version") do
+    puts Aurora::VERSION
+    exit
+  end
   opts.on("-h", "--help", "Prints this help") do
     puts opts
     exit
@@ -75,7 +80,7 @@ class MQTTBridge
           end
         end
       end
-    rescue StandardError => e
+    rescue => e
       warn "failed processing message: #{e}\n#{e.backtrace}"
     end
 
@@ -119,41 +124,44 @@ class MQTTBridge
   end
 
   def publish_basic_attributes
-    @homie_abc = @homie.node("abc", "Aurora Basic Control", "ABC") do |node|
+    @homie_abc = @homie.node("abc", "Heat Pump", "ABC") do |node|
       allowed_modes = %w[lockout standby blower heating cooling eh1 eh2 emergency waiting]
       allowed_modes << "dehumidify" if @abc.compressor.is_a?(Aurora::Compressor::VSDrive)
       node.property("current-mode", "Current Heating/Cooling Mode", :enum, @abc.current_mode,
                     format: allowed_modes)
       node.property("entering-air-temperature", "Entering Air Temperature", :float, @abc.entering_air_temperature,
-                    unit: "ºF")
+                    unit: "°F")
       node.property("entering-water-temperature", "Entering Water Temperature", :float,
-                    @abc.entering_water_temperature, unit: "ºF")
+                    @abc.entering_water_temperature, unit: "°F")
       node.property("leaving-air-temperature", "Leaving Air Temperature", :float, @abc.leaving_air_temperature,
-                    unit: "ºF")
+                    unit: "°F")
       node.property("leaving-water-temperature", "Leaving Water Temperature", :float, @abc.leaving_water_temperature,
-                    unit: "ºF")
+                    unit: "°F")
       unless @abc.outdoor_temperature.zero? # TODO: figure out the config if this actually exists
-        node.property("outdoor-temperature", "Outdoor Temperature", :float, @abc.outdoor_temperature, unit: "ºF")
+        node.property("outdoor-temperature", "Outdoor Temperature", :float, @abc.outdoor_temperature, unit: "°F")
       end
 
-      node.property("fp1", "FP1 Sensor", :float, @abc.fp1, unit: "ºF")
-      node.property("fp2", "FP2 Sensor", :float, @abc.fp2, unit: "ºF")
+      node.property("fp1", "FP1 Sensor", :float, @abc.fp1, unit: "°F")
+      node.property("fp2", "FP2 Sensor", :float, @abc.fp2, unit: "°F")
       %i[aux_heat total].each do |component|
         component = "#{component}_watts"
-        node.property(component.tr("_", "-"), component.tr("_", " ").titleize, :integer,
-                      @abc.public_send(component), unit: "W")
+        node.property(component.tr("_", "-"),
+                      component.sub("_watts", " Power Usage").tr("_", " ").titleize,
+                      :integer,
+                      @abc.public_send(component),
+                      unit: "W")
       end
     end
 
     @compressor = @homie.node("compressor", "Compressor", @abc.compressor.type) do |node|
-      node.property("speed", "Current compressor speed", :integer, @abc.compressor.speed,
+      node.property("speed", "Current Speed", :integer, @abc.compressor.speed,
                     format: @abc.compressor.speed_range)
-      node.property("watts", "Energy Usage", :integer, @abc.compressor.watts, unit: "W") if @abc.energy_monitoring?
+      node.property("watts", "Power Usage", :integer, @abc.compressor.watts, unit: "W") if @abc.energy_monitoring?
 
       next unless @abc.compressor.is_a?(Aurora::Compressor::VSDrive)
 
-      node.property("ambient-temperature", "Compressor ambient temperature", :float,
-                    @abc.compressor.ambient_temperature, unit: "ºF")
+      node.property("ambient-temperature", "Ambient Temperature", :float,
+                    @abc.compressor.ambient_temperature, unit: "°F")
 
       next unless @abc.iz2?
 
@@ -162,19 +170,19 @@ class MQTTBridge
     end
 
     @blower = @homie.node("blower", "Blower", @abc.blower.type) do |node|
-      node.property("running", "Blower is running", :boolean, @abc.blower.running?)
+      node.property("running", "Running", :boolean, @abc.blower.running?)
       if @abc.blower.respond_to?(:speed)
-        node.property("speed", "Current blower speed", :integer, @abc.blower.speed, format: @abc.blower.speed_range)
+        node.property("speed", "Current 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?
+      node.property("watts", "Power Usage", :integer, @abc.blower.watts, unit: "W") if @abc.energy_monitoring?
 
       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.each do |setting|
-        field = "#{setting.tr('-', '_')}_speed"
-        node.property("#{setting}-speed", "#{setting.tr('-', ' ').titleize} Preset Speed", :integer,
+        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
@@ -188,23 +196,23 @@ class MQTTBridge
 
     @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?
+      node.property("watts", "Power Usage", :integer, @abc.pump.watts, unit: "W") if @abc.energy_monitoring?
 
       next unless @abc.pump.is_a?(Aurora::Pump::VSPump)
 
-      node.property("running", "Pump is running", :boolean, @abc.pump.running)
+      node.property("running", "Running", :boolean, @abc.pump.running)
       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,
+      node.property("manual-control", "Manual Control", :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,
+      node.property("minimum-speed", "Actual Minimum Speed", :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,
+      node.property("maximum-speed", "Actual Maximum Speed", :integer, @abc.pump.minimum_speed,
                     format: 0..100, unit: "%") do |value, property|
         @mutex.synchronize { property.value = @abc.pump.maximum_speed = value }
       end
@@ -215,11 +223,11 @@ class MQTTBridge
         node.property("enabled", "Enabled", :boolean, @abc.dhw.enabled) do |value, property|
           @mutex.synchronize { property.value = @abc.dhw.enabled = value }
         end
-        node.property("running", "DHW Pump is running", :boolean, @abc.dhw.running?)
+        node.property("running", "Pump Running", :boolean, @abc.dhw.running?)
         node.property("water-temperature", "Water Temperature", :float,
-                      @abc.dhw.water_temperature, unit: "ºF")
+                      @abc.dhw.water_temperature, unit: "°F")
         node.property("set-point", "Set Point", :float, @abc.dhw.set_point, format: 100..140,
-                                                                            unit: "ºF") do |value, property|
+                                                                            unit: "°F") do |value, property|
           @mutex.synchronize { property.value = @abc.dhw.set_point = value }
         end
       end
@@ -227,14 +235,14 @@ class MQTTBridge
 
     @humidistat = @homie.node("humidistat", "Humidistat", "Humidistat") do |node|
       node.property("relative-humidity", "Relative Humidity", :integer, @abc.humidistat.relative_humidity,
-         unit: "%", format: 0..100)
+                    unit: "%", format: 0..100)
       if @abc.humidistat.humidifier?
-        node.property("humidifier-running", "Humidifier is running", :boolean, @abc.humidistat.humidifier_running?)
+        node.property("humidifier-running", "Humidifier Running", :boolean, @abc.humidistat.humidifier_running?)
         node.property("humidifier-mode", "Humidifier Mode", :enum, @abc.humidistat.humidifier_mode,
                       format: %i[auto manual]) do |value, property|
           @mutex.synchronize { property.value = @abc.humidistat.humidifier_mode = value.to_sym }
         end
-        node.property("humidification-target", "Humidification target relative humidity", :integer,
+        node.property("humidification-target", "Humidification Target Relative Humidity", :integer,
                       @abc.humidistat.humidification_target, unit: "%", format: 15..50) do |value, property|
           @mutex.synchronize { property.value = @abc.humidistat.humidification_target = value }
         end
@@ -246,7 +254,7 @@ class MQTTBridge
                       format: %i[auto manual]) do |value, property|
           @mutex.synchronize { property.value = @abc.humidistat.dehumidifier_mode = value.to_sym }
         end
-        node.property("dehumidification-target", "Dehumidification target relative humidity", :integer,
+        node.property("dehumidification-target", "Dehumidification Target Relative Humidity", :integer,
                       @abc.humidistat.dehumidification_target, unit: "%", format: 35..65) do |value, property|
           @mutex.synchronize { property.value = @abc.humidistat.dehumidification_target = value }
         end
@@ -254,11 +262,11 @@ class MQTTBridge
 
       next unless @abc.humidistat.dehumidifier?
 
-      node.property("dehumidifier-running", "Dehumidifier is running", :boolean, @abc.humidistat.dehumidifier_running?)
+      node.property("dehumidifier-running", "Dehumidifier Running", :boolean, @abc.humidistat.dehumidifier_running?)
     end
 
     @faults = @homie.node("faults", "Fault History", "ABC") do |node|
-      node.property("clear-history", "Reset fault counts", :enum, retained: false, format: "clear") do |_|
+      node.property("clear-history", "Reset Fault Counts", :enum, retained: false, format: "clear") do |_|
         @mutex.synchronize { @abc.clear_fault_history }
       end
       @abc.faults.each_with_index do |count, i|
@@ -298,13 +306,13 @@ class MQTTBridge
           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("ambient-temperature", "Ambient Temperature", :float, zone.ambient_temperature, unit: "ºF")
+        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|
+                      zone.heating_target_temperature, unit: "°F", format: 40..90) do |value, property|
           @mutex.synchronize { property.value = zone.heating_target_temperature = value }
         end
         node.property("cooling-target-temperature", "Cooling Target Temperature", :integer,
-                      zone.cooling_target_temperature, unit: "ºF", format: 54..99) do |value, property|
+                      zone.cooling_target_temperature, unit: "°F", format: 54..99) do |value, property|
           @mutex.synchronize { property.value = zone.cooling_target_temperature = value }
         end
       end
@@ -314,7 +322,175 @@ class MQTTBridge
     @homie.mqtt.subscribe("#{@homie.topic}/$modbus")
     @homie.mqtt.subscribe("#{@homie.topic}/$modbus/getregs")
     @homie.mqtt.subscribe("#{@homie.topic}/$modbus/+/set")
-    @homie.publish
+    @homie.publish do
+      # do HASS publishes in this block so they're done in bulk
+
+      MQTT::HomeAssistant.publish_sensor(@homie["abc"]["current-mode"],
+                                         device_class: :power)
+      MQTT::HomeAssistant.publish_sensor(@homie["abc"]["entering-air-temperature"],
+                                         device_class: :temperature,
+                                         entity_category: :diagnostic)
+      MQTT::HomeAssistant.publish_sensor(@homie["abc"]["entering-water-temperature"],
+                                         device_class: :temperature,
+                                         entity_category: :diagnostic)
+      MQTT::HomeAssistant.publish_sensor(@homie["abc"]["leaving-air-temperature"],
+                                         device_class: :temperature,
+                                         entity_category: :diagnostic)
+      MQTT::HomeAssistant.publish_sensor(@homie["abc"]["leaving-water-temperature"],
+                                         device_class: :temperature,
+                                         entity_category: :diagnostic)
+      unless @abc.outdoor_temperature.zero?
+        MQTT::HomeAssistant.publish_sensor(@homie["abc"]["outdoor-temperature"],
+                                           device_class: :temperature)
+      end
+      MQTT::HomeAssistant.publish_sensor(@homie["abc"]["fp1"],
+                                         device_class: :temperature,
+                                         entity_category: :diagnostic)
+      MQTT::HomeAssistant.publish_sensor(@homie["abc"]["fp2"],
+                                         device_class: :temperature,
+                                         entity_category: :diagnostic)
+      MQTT::HomeAssistant.publish_sensor(@homie["abc"]["aux-heat-watts"],
+                                         device_class: :power)
+      MQTT::HomeAssistant.publish_sensor(@homie["abc"]["total-watts"],
+                                         device_class: :power)
+
+      MQTT::HomeAssistant.publish_sensor(@homie["compressor"]["speed"])
+      MQTT::HomeAssistant.publish_sensor(@homie["compressor"]["watts"],
+                                         device_class: :power)
+
+      if @abc.compressor.is_a?(Aurora::Compressor::VSDrive)
+        MQTT::HomeAssistant.publish_sensor(@homie["compressor"]["ambient-temperature"],
+                                           device_class: :temperature,
+                                           entity_category: :diagnostic)
+
+        if @abc.iz2?
+          MQTT::HomeAssistant.publish_sensor(@homie["compressor"]["iz2-desired-speed"],
+                                             entity_category: :diagnostic)
+        end
+      end
+
+      MQTT::HomeAssistant.publish_binary_sensor(@homie["blower"]["running"],
+                                                device_class: :running)
+      MQTT::HomeAssistant.publish_sensor(@homie["blower"]["speed"]) if @abc.blower.respond_to?(:speed)
+      MQTT::HomeAssistant.publish_sensor(@homie["blower"]["watts"],
+                                         device_class: :power)
+      MQTT::HomeAssistant.publish_number(@homie["blower"]["blower-only-speed"],
+                                         entity_category: :config)
+      MQTT::HomeAssistant.publish_number(@homie["blower"]["aux-heat-speed"],
+                                         entity_category: :config)
+      if @abc.iz2?
+        MQTT::HomeAssistant.publish_sensor(@homie["blower"]["iz2-desired-speed"])
+      else
+        MQTT::HomeAssistant.publish_number(@homie["blower"]["low-compressor-speed"],
+                                           entity_category: :config)
+        MQTT::HomeAssistant.publish_number(@homie["blower"]["high-compressor-speed"],
+                                           entity_category: :config)
+      end
+
+      MQTT::HomeAssistant.publish_sensor(@homie["pump"]["waterflow"],
+                                         entity_category: :diagnostic)
+      MQTT::HomeAssistant.publish_sensor(@homie["pump"]["watts"],
+                                         device_class: :power)
+
+      if @abc.pump.is_a?(Aurora::Pump::VSPump)
+        MQTT::HomeAssistant.publish_binary_sensor(@homie["pump"]["running"],
+                                                  device_class: :running)
+        MQTT::HomeAssistant.publish_number(@homie["pump"]["speed"],
+                                           entity_category: :diagnostic)
+
+        MQTT::HomeAssistant.publish_switch(@homie["pump"]["manual-control"],
+                                           entity_category: :diagnostic)
+        MQTT::HomeAssistant.publish_number(@homie["pump"]["minimum-speed"],
+                                           entity_category: :config)
+        MQTT::HomeAssistant.publish_number(@homie["pump"]["maximum-speed"],
+                                           entity_category: :config)
+      end
+
+      MQTT::HomeAssistant.publish_scene(@homie["faults"]["clear-history"])
+      @homie["faults"].each do |property|
+        next if property.id == "clear-history"
+
+        MQTT::HomeAssistant.publish_sensor(property,
+                                           entity_category: :diagnostic)
+      end
+
+      if @abc.dhw
+        MQTT::HomeAssistant.publish_switch(@homie["dhw"]["enabled"],
+                                           icon: "mdi:water-boiler")
+        MQTT::HomeAssistant.publish_binary_sensor(@homie["dhw"]["running"],
+                                                  device_class: :running)
+        MQTT::HomeAssistant.publish_sensor(@homie["dhw"]["water-temperature"],
+                                           device_class: :temperature)
+        MQTT::HomeAssistant.publish_number(@homie["dhw"]["set-point"])
+      end
+
+      MQTT::HomeAssistant.publish_sensor(@homie["humidistat"]["relative-humidity"],
+                                         device_class: :humidity)
+      if @abc.humidistat.humidifier?
+        MQTT::HomeAssistant.publish_humidifier(
+          @homie["humidistat"]["humidifier-running"],
+          device_class: :humidifier,
+          name: "Humidifier",
+          id: "humidifier",
+          target_property: @homie["humidistat"]["humidification-target"],
+          mode_property: @homie["humidistat"]["humidifier-mode"]
+        )
+      end
+      if @abc.humidistat.dehumidifier? || @abc.compressor.is_a?(Aurora::Compressor::VSDrive)
+        property = if @abc.humidistat.dehumidifier?
+                     @homie["humidistat"]["dehumidifier-running"]
+                   else
+                     # yeah, this isn't right, but we have to give HASS _something_
+                     @homie["humidistat"]["humidifier-running"]
+                   end
+        MQTT::HomeAssistant.publish_humidifier(
+          property,
+          device_class: :dehumidifier,
+          name: "Dehumidifier",
+          id: "dehumidifier",
+          target_property: @homie["humidistat"]["dehumidification-target"],
+          mode_property: @homie["humidistat"]["dehumidifier-mode"]
+        )
+      end
+
+      @abc.zones.each_with_index do |zone, i|
+        homie_zone = @homie["zone#{i + 1}"]
+        MQTT::HomeAssistant.publish_climate(
+          action_property: homie_zone["current-mode"],
+          current_temperature_property: homie_zone["ambient-temperature"],
+          fan_mode_property: homie_zone["target-fan-mode"],
+          mode_property: homie_zone["target-mode"],
+          temperature_high_property: homie_zone["cooling-target-temperature"],
+          temperature_low_property: homie_zone["heating-target-temperature"],
+          templates: {
+            action_template: <<~JINJA
+              {% if value.startswith('h') %}
+                heating
+              {% elif value.startswith('c') %}
+                cooling
+              {% elif value == 'standby' %}
+                idle
+              {% endif %}
+            JINJA
+          }
+        )
+        MQTT::HomeAssistant.publish_binary_sensor(homie_zone["current-fan-mode"],
+                                                  device_class: :running)
+        MQTT::HomeAssistant.publish_select(homie_zone["fan-intermittent-on"],
+                                           entity_category: :config)
+        MQTT::HomeAssistant.publish_select(homie_zone["fan-intermittent-off"],
+                                           entity_category: :config)
+
+        next unless zone.is_a?(Aurora::IZ2Zone)
+
+        MQTT::HomeAssistant.publish_sensor(homie_zone["priority"],
+                                           entity_category: :diagnostic)
+        MQTT::HomeAssistant.publish_sensor(homie_zone["size"],
+                                           entity_category: :diagnostic)
+        MQTT::HomeAssistant.publish_sensor(homie_zone["normalized-size"],
+                                           entity_category: :diagnostic)
+      end
+    end
   end
 end
 
@@ -324,7 +500,7 @@ logger.level = log_level
 abc.modbus_slave.logger = logger
 
 device = "aurora-#{abc.serial_number}"
-homie = MQTT::Homie::Device.new(device, "Aurora MQTT Bridge", mqtt: mqtt_uri)
+homie = MQTT::Homie::Device.new(device, "WaterFurnace", mqtt: mqtt_uri)
 homie.logger = logger
 
 MQTTBridge.new(abc, homie)

data/exe/web_aid_tool

@@ -14,6 +14,10 @@ options = OptionParser.new do |opts|
 
   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("-v", "--version", "Print version") do
+    puts Aurora::VERSION
+    exit
+  end
   opts.on("-h", "--help", "Prints this help") do
     puts opts
     exit
@@ -116,3 +120,7 @@ get "/request.cgi" do
 
   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!

data/lib/aurora/abc_client.rb

@@ -92,14 +92,14 @@ module Aurora
                 when 3 then Blower::FiveSpeed.new(self, registers[404])
                 else; Blower::PSC.new(self, registers[404])
                 end
-      @pump = if (3..5).include?(raw_registers[413])
+      @pump = if (3..5).cover?(raw_registers[413])
                 Pump::VSPump.new(self,
                                  registers[413])
               else
                 Pump::GenericPump.new(self,
                                       registers[413])
               end
-      @dhw = DHW.new(self) if (-999..999).include?(registers[1114])
+      @dhw = DHW.new(self) if (-999..999).cover?(registers[1114])
       @humidistat = Humidistat.new(self,
                                    @abc_dipswitches[:accessory_relay] == :humidifier,
                                    @axb_dipswitches[:accessory_relay2] == :dehumidifier)
@@ -171,7 +171,7 @@ module Aurora
       @fp2                        = registers[20]
       @locked_out                 = registers[25] & 0x8000
       @error                      = registers[25] & 0x7fff
-      @derated                    = (41..46).include?(@error)
+      @derated                    = (41..46).cover?(@error)
       @safe_mode                  = [47, 48, 49, 72, 74].include?(@error)
       @aux_heat_watts             = registers[1151]
       @total_watts                = registers[1153]
@@ -212,7 +212,7 @@ module Aurora
     end
 
     def line_voltage=(value)
-      raise ArgumentError unless (90..635).include?(value)
+      raise ArgumentError unless (90..635).cover?(value)
 
       @modbus_slave.holding_registers[112] = value
     end
@@ -227,13 +227,13 @@ module Aurora
                          pump_speed: :with_compressor,
                          aux_heat: false)
       raise ArgumentError, "mode must be :off, :heating, or :cooling" unless %i[off heating cooling].include?(mode)
-      raise ArgumentError, "compressor speed must be between 0 and 12" unless (0..12).include?(compressor_speed)
+      raise ArgumentError, "compressor speed must be between 0 and 12" unless (0..12).cover?(compressor_speed)
 
-      unless blower_speed == :with_compressor || (0..12).include?(blower_speed)
+      unless blower_speed == :with_compressor || (0..12).cover?(blower_speed)
         raise ArgumentError,
               "blower speed must be :with_compressor or between 0 and 12"
       end
-      unless pump_speed == :with_compressor || (0..100).include?(pump_speed)
+      unless pump_speed == :with_compressor || (0..100).cover?(pump_speed)
         raise ArgumentError,
               "pump speed must be :with_compressor or between 0 and 100"
       end
@@ -273,7 +273,7 @@ module Aurora
     def inspect
       "#<Aurora::ABCClient #{(instance_variables - [:@modbus_slave]).map do |iv|
                                "#{iv}=#{instance_variable_get(iv).inspect}"
-                             end.join(', ')}>"
+                             end.join(", ")}>"
     end
   end
 end

data/lib/aurora/blower.rb

@@ -6,7 +6,7 @@ module Aurora
   module Blower
     class PSC < Component
       attr_reader :type, :watts, :running
-      alias running? running
+      alias_method :running?, :running
 
       def initialize(abc, type)
         super(abc)

data/lib/aurora/component.rb

@@ -9,7 +9,7 @@ module Aurora
     def inspect
       "#<Aurora::#{self.class.name} #{(instance_variables - [:@abc]).map do |iv|
                                         "#{iv}=#{instance_variable_get(iv).inspect}"
-                                      end.join(', ')}>"
+                                      end.join(", ")}>"
     end
 
     private

data/lib/aurora/compressor.rb

@@ -13,7 +13,7 @@ module Aurora
       end
 
       def type
-        "#{@stages == 2 ? 'Dual' : 'Single'} Stage Compressor"
+        "#{@stages == 2 ? "Dual" : "Single"} Stage Compressor"
       end
 
       def speed_range

data/lib/aurora/dhw.rb

@@ -5,7 +5,7 @@ require "aurora/component"
 module Aurora
   class DHW < Component
     attr_reader :enabled, :running, :set_point, :water_temperature
-    alias running? running
+    alias_method :running?, :running
 
     def registers_to_read
       [400..401, 1114]
@@ -23,7 +23,7 @@ module Aurora
     end
 
     def set_point=(value) # rubocop:disable Naming/AccessorMethodName
-      raise ArgumentError unless (100..140).include?(value)
+      raise ArgumentError unless (100..140).cover?(value)
 
       raw_value = (value * 10).to_i
       holding_registers[401] = raw_value

data/lib/aurora/humidistat.rb

@@ -7,8 +7,8 @@ module Aurora
     attr_reader :humidifier_running, :humidifier_mode, :humidification_target,
                 :dehumidifier_running, :dehumidifier_mode, :dehumidification_target,
                 :relative_humidity
-    alias humidifier_running? humidifier_running
-    alias dehumidifer_running? dehumidifier_running
+    alias_method :humidifier_running?, :humidifier_running
+    alias_method :dehumidifer_running?, :dehumidifier_running
 
     def initialize(abc, has_humidifier, has_dehumidifier)
       super(abc)
@@ -43,7 +43,7 @@ module Aurora
 
       base = abc.iz2? ? 31_109 : 12_309
       humidifier_settings_register = abc.iz2? ? 21_114 : 12_309
-      @humidifier_settings = registers[humidifier_settings_register]&.last&.[](2..)&.to_i(16)
+      @humidifier_settings = registers[humidifier_settings_register]&.last&.[](2..-1)&.to_i(16)
       @humidifier_mode = registers[humidifier_settings_register]&.include?(:auto_humidification) ? :auto : :manual
       @dehumidifier_mode = registers[humidifier_settings_register]&.include?(:auto_dehumidification) ? :auto : :manual
 
@@ -82,8 +82,8 @@ module Aurora
     end
 
     def set_humidistat_targets(humidification_target, dehumidification_target)
-      raise ArgumentError unless (15..50).include?(humidification_target)
-      raise ArgumentError unless (35..65).include?(dehumidification_target)
+      raise ArgumentError unless (15..50).cover?(humidification_target)
+      raise ArgumentError unless (35..65).cover?(dehumidification_target)
 
       holding_registers[abc.iz2? ? 21_115 : 12_310] = (humidification_target << 8) + dehumidification_target
       @humidification_target = humidification_target

data/lib/aurora/iz2_zone.rb

@@ -15,18 +15,18 @@ module Aurora
     end
 
     def registers_to_read
-      base1 = 21_203 + (zone_number - 1) * 9
-      base2 = 31_007 + (zone_number - 1) * 3
-      base3 = 31_200 + (zone_number - 1) * 3
+      base1 = 21_203 + ((zone_number - 1) * 9)
+      base2 = 31_007 + ((zone_number - 1) * 3)
+      base3 = 31_200 + ((zone_number - 1) * 3)
       [base1..(base1 + 1), base2..(base2 + 2), base3]
     end
 
     def refresh(registers)
-      @ambient_temperature = registers[31_007 + (zone_number - 1) * 3]
+      @ambient_temperature = registers[31_007 + ((zone_number - 1) * 3)]
 
-      config1 = registers[31_008 + (zone_number - 1) * 3]
-      config2 = registers[31_009 + (zone_number - 1) * 3]
-      config3 = registers[31_200 + (zone_number - 1) * 3]
+      config1 = registers[31_008 + ((zone_number - 1) * 3)]
+      config2 = registers[31_009 + ((zone_number - 1) * 3)]
+      config3 = registers[31_200 + ((zone_number - 1) * 3)]
 
       @target_fan_mode = config1[:fan]
       @fan_intermittent_on = config1[:on_time]
@@ -45,28 +45,28 @@ module Aurora
     def target_mode=(value)
       return unless (raw_value = Aurora::HEATING_MODE.invert[value])
 
-      holding_registers[21_202 + (zone_number - 1) * 9] = raw_value
+      holding_registers[21_202 + ((zone_number - 1) * 9)] = raw_value
       @target_mode = value
     end
 
     def target_fan_mode=(value)
       return unless (raw_value = Aurora::FAN_MODE.invert[value])
 
-      holding_registers[21_205 + (zone_number - 1) * 9] = raw_value
+      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?
 
-      holding_registers[21_206 + (zone_number - 1) * 9] = value
+      holding_registers[21_206 + ((zone_number - 1) * 9)] = value
       @fan_intermittent_on = value
     end
 
     def fan_intermittent_off=(value)
       return unless value >= 0 && value <= 40 && (value % 5).zero?
 
-      holding_registers[21_207 + (zone_number - 1) * 9] = value
+      holding_registers[21_207 + ((zone_number - 1) * 9)] = value
       @fan_intermittent_off = value
     end
 
@@ -74,7 +74,7 @@ module Aurora
       return unless value >= 40 && value <= 90
 
       raw_value = (value * 10).to_i
-      holding_registers[21_203 + (zone_number - 1) * 9] = raw_value
+      holding_registers[21_203 + ((zone_number - 1) * 9)] = raw_value
       @heating_target_temperature = value
     end
 
@@ -82,7 +82,7 @@ module Aurora
       return unless value >= 54 && value <= 99
 
       raw_value = (value * 10).to_i
-      holding_registers[21_204 + (zone_number - 1) * 9] = raw_value
+      holding_registers[21_204 + ((zone_number - 1) * 9)] = raw_value
       @cooling_target_temperature = value
     end
   end

data/lib/aurora/mock_abc.rb

@@ -44,6 +44,6 @@ module Aurora
     def write_holding_register(addr, value)
       @registers[addr] = value
     end
-    alias []= write_holding_register
+    alias_method :[]=, :write_holding_register
   end
 end

data/lib/aurora/modbus/server.rb

@@ -10,20 +10,20 @@ module Aurora
           return unless ((req.length - 1) % 4).zero?
 
           params = []
-          req[1..].unpack("n*").each_slice(2) do |(addr, quant)|
+          req[1..-1].unpack("n*").each_slice(2) do |(addr, quant)|
             params << { addr: addr, quant: quant }
           end
           params
         when 66
           return unless ((req.length - 1) % 2).zero?
 
-          req[1..].unpack("n*")
+          req[1..-1].unpack("n*")
         when 67
           # 1 function register, a multiple of two words
           return unless ((req.length - 1) % 4).zero?
 
           params = []
-          req[1..].unpack("n*").each_slice(2) do |(addr, val)|
+          req[1..-1].unpack("n*").each_slice(2) do |(addr, val)|
             params << { addr: addr, val: val }
           end
           params

data/lib/aurora/modbus/slave.rb

@@ -4,14 +4,14 @@ module Aurora
   module ModBus
     module Slave
       def read_multiple_holding_registers(*ranges)
-        values = if ranges.any? { |r| r.is_a?(Range) }
+        values = if ranges.any?(Range)
                    addrs_and_lengths = ranges.map do |r|
                      r = Array(r)
                      [r.first, r.last - r.first + 1]
                    end.flatten
-                   query("A#{addrs_and_lengths.pack('n*')}").unpack("n*")
+                   query("A#{addrs_and_lengths.pack("n*")}").unpack("n*")
                  else
-                   query("B#{ranges.pack('n*')}").unpack("n*")
+                   query("B#{ranges.pack("n*")}").unpack("n*")
                  end
         ranges.map { |r| Array(r) }.flatten.zip(values).to_h
       end

data/lib/aurora/mqtt_modbus.rb

@@ -11,7 +11,7 @@ module Aurora
       @mqtt = MQTT::Client.new(uri)
       @mqtt.connect
 
-      @base_topic = uri.path[1..]
+      @base_topic = uri.path[1..-1]
       @mqtt.subscribe("#{@base_topic}/getregs/response")
     end
 

data/lib/aurora/pump.rb

@@ -6,7 +6,7 @@ module Aurora
   module Pump
     class GenericPump < Component
       attr_reader :type, :watts, :waterflow, :running
-      alias running? running
+      alias_method :running?, :running
 
       def initialize(abc, type)
         super(abc)
@@ -28,7 +28,7 @@ module Aurora
 
     class VSPump < GenericPump
       attr_reader :speed, :minimum_speed, :maximum_speed, :manual_control
-      alias manual_control? manual_control
+      alias_method :manual_control?, :manual_control
 
       def registers_to_read
         super + [321..325]

data/lib/aurora/registers.rb

@@ -108,7 +108,7 @@ module Aurora
     48 => "EEV OD Comm Error", # Com with EEV is interupted EEV has gone independent mode
     49 => "Cabinet Temperature Sensor", # Ambient Temperature (Tamb) is <-76 or > 212 F and out of range or invalid
     51 => "Discharge Temp Sensor", # Discharge Sensor (Sd) is > 280 F or invalid (-76 to 392 F)
-    52 => "Suction Presure Sensor", # Suction Pressure (P0) is invalid (0 to 232 psi)
+    52 => "Suction Pressure Sensor", # Suction Pressure (P0) is invalid (0 to 232 psi)
     53 => "Condensing Pressure Sensor", # Low condensing pressure (PD) or invalid (0 to 870 psi) Retry 10x.
     54 => "Low Supply Voltage", # Supply Voltage is <180 V (190V to reset) or powered off/on too quickly (<30 sec.).
     55 => "Out of Envelope", # Comp Operating out of envelope (P0) more than 90 sec. Retry 10x.
@@ -186,7 +186,7 @@ module Aurora
     "RPM Sensor Signal Fault" => (78..82),
     "Under-Voltage Stop" => (83..87),
     "Rotor Locked" => (88..92),
-    "Standby" => (93..)
+    "Standby" => (93..99) # should be infinite, but ruby 2.5 doesn't support it
   }.freeze
 
   def vs_fault(value)
@@ -550,7 +550,7 @@ module Aurora
   REGISTER_FORMATS = {
     "%ds" => [1, 6, 9, 15, 84, 85, 110],
     "%dV" => [16, 112, 3331, 3424, 3523],
-    "%0.1fºF" => [19, 20, 401, 501, 502, 567, 740, 745, 746, 747, 900, 903,
+    "%0.1f°F" => [19, 20, 401, 501, 502, 567, 740, 745, 746, 747, 900, 903,
                   1109, 1110, 1111, 1112, 1113, 1114, 1124, 1125, 1134, 1135, 1136,
                   3325, 3326, 3327, 3330, 3522, 3903, 3905, 3906,
                   12_619, 12_620,
@@ -587,9 +587,9 @@ module Aurora
 
   def zone_registers
     (1..6).map do |i|
-      base1 = 21_202 + (i - 1) * 9
-      base2 = 31_007 + (i - 1) * 3
-      base3 = 31_200 + (i - 1) * 3
+      base1 = 21_202 + ((i - 1) * 9)
+      base2 = 31_007 + ((i - 1) * 3)
+      base3 = 31_200 + ((i - 1) * 3)
       {
         base1 => "Zone #{i} Heating Mode (write)",
         (base1 + 1) => "Zone #{i} Heating Setpoint (write)",

data/lib/aurora/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: waterfurnace_aurora
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-02 00:00:00.000000000 Z
+date: 2021-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ccutrer-serialport
@@ -25,19 +25,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: homie-mqtt
+  name: mqtt-homeassistant
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.4
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.4
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: net-telnet-rfc2217
   requirement: !ruby/object:Gem::Requirement
@@ -92,32 +98,59 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: '1.23'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: '0.6'
 description: 
 email: cody@cutrer.com'
 executables:
-- grab_awl_assets.sh
 - aurora_monitor
 - aurora_mqtt_bridge
 - web_aid_tool
@@ -130,7 +163,6 @@ files:
 - exe/aurora_mock
 - exe/aurora_monitor
 - exe/aurora_mqtt_bridge
-- exe/grab_awl_assets.sh
 - exe/web_aid_tool
 - lib/aurora.rb
 - lib/aurora/abc_client.rb
@@ -150,10 +182,11 @@ files:
 - lib/aurora/thermostat.rb
 - lib/aurora/version.rb
 - lib/waterfurnace_aurora.rb
-homepage: https://github.com/ccutrer/waterfurnace
+homepage: https://github.com/ccutrer/waterfurnace_aurora
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -162,7 +195,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/exe/grab_awl_assets.sh

@@ -1,21 +0,0 @@
-#!/bin/bash
-
-mkdir -p html
-mkdir -p html/css
-mkdir -p html/js
-mkdir -p html/images
-
-IP=${1:-172.20.10.1}
-
-curl http://$IP/ > html/index.htm
-curl http://$IP/config.htm > html/config.htm
-curl http://$IP/favicon.ico > html/favicon.ico
-curl http://$IP/css/index.css > html/css/index.css
-curl http://$IP/css/phone.css > html/css/phone.css
-curl http://$IP/js/indexc.js > html/js/indexc.js
-curl http://$IP/js/configc.js > html/js/configc.js
-curl http://$IP/images/aurora.png > html/images/aurora.png
-curl http://$IP/images/back.png > html/images/back.png
-curl http://$IP/images/cfailed.png > html/images/cfailed.png
-curl http://$IP/images/cgood.png > html/images/cgood.png
-curl http://$IP/images/cidle.png > html/images/cidle.png