waterfurnace_aurora 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64e8260cab984391d973114e5e09a98cc4331c166d13f1797bab6e0f292d2953
-  data.tar.gz: b0a430cbf5310a30c839e9ca19807081aa316cffa80ce3c230fcffe5af928ab0
+  metadata.gz: 1bbf110fc6004aa69327e04b6a778fb2b59db4357cbd4c9f519805b581a2d505
+  data.tar.gz: dc95dcbaa26625f59b3822adae5c1e1e0dc38483df90d8ba10b5f417824d845f
 SHA512:
-  metadata.gz: cce5f85f7b11c6910b294511faa7ea13b0319e58523cd8e42832f03983870296659286aa071db9761cd5c33df3a107d2ae9d6d5b33e430a96daf07b9366111eb
-  data.tar.gz: 5f8affbb114893a9a67accd843b70f1a328b54d9c1485b455740e056b5f1d465f86e20a86e1d13b6c3cd7e2a9ddeabef5d6d72771c811cb5101b57bdfd881379
+  metadata.gz: f82a6d294a7643c0cfcc504a7e78f3eced539579d950d70f2ceb66f144891af71269c05c2cdffa2c505ae03175220317cd0b3cfffcedc092e1b3d014ede2a847
+  data.tar.gz: 486d293ef3021d2c0342cfaa4a7286eef0e7e0854cbaa79be1d453c274d492f94c2bb78ae920bf6442ccc7c90b4b4cae416b67d0ccb9ca3d9c539fcd8c890497

data/exe/aurora_fetch

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "aurora"
+require "ccutrer-serialport"
+require "uri"
+
+uri = URI.parse(ARGV[0])
+
+args = if uri.scheme == "telnet" || uri.scheme == "rfc2217"
+         require "net/telnet/rfc2217"
+         [Net::Telnet::RFC2217.new("Host" => uri.host,
+                                   "Port" => uri.port || 23,
+                                   "baud" => 19_200,
+                                   "parity" => Net::Telnet::RFC2217::EVEN)]
+       else
+         [CCutrer::SerialPort.new(uri.path, baud: 19_200, parity: :even)]
+       end
+
+client = ModBus::RTUClient.new(*args)
+client.debug = true
+slave = client.with_slave(1)
+
+registers = slave.holding_registers[ARGV[1].to_i]
+
+puts registers.inspect

data/{bin → exe}/aurora_mock

@@ -1,21 +1,22 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require 'aurora'
-require 'ccutrer-serialport'
-require 'uri'
-require 'yaml'
+require "aurora"
+require "ccutrer-serialport"
+require "uri"
+require "yaml"
 
 uri = URI.parse(ARGV[0])
 
 args = if uri.scheme == "telnet" || uri.scheme == "rfc2217"
-  require 'net/telnet/rfc2217'
-  [Net::Telnet::RFC2217.new('Host' => uri.host,
-    'Port' => uri.port || 23,
-    'baud' => 19200,
-    'parity' => Net::Telnet::RFC2217::EVEN)]
-else
-  [CCutrer::SerialPort.new(uri.path, baud: 19200, parity: :even)]
-end
+         require "net/telnet/rfc2217"
+         [Net::Telnet::RFC2217.new("Host" => uri.host,
+                                   "Port" => uri.port || 23,
+                                   "baud" => 19_200,
+                                   "parity" => Net::Telnet::RFC2217::EVEN)]
+       else
+         [CCutrer::SerialPort.new(uri.path, baud: 19_200, parity: :even)]
+       end
 
 port = ARGV[1]&.to_i || 502
 
@@ -27,13 +28,13 @@ slave2 = server1.with_slave(2)
 server2 = ModBus::TCPServer.new(port)
 slave255 = server2.with_slave(255)
 
-r = slave1.holding_registers = slave2.holding_registers = slave255.holding_registers = Array.new(31473, 0)
+r = slave1.holding_registers = slave2.holding_registers = slave255.holding_registers = Array.new(31_473, 0)
 
 # prepopulate some data
-registers = YAML.load(File.read(File.expand_path('../registers.yml', __FILE__)))
+registers = YAML.safe_load(File.read(File.expand_path("registers.yml", __dir__)))
 registers.each { |(k, v)| r[k] = v }
 
-server1.request_callback = ->(uid, func, req) do
+server1.request_callback = lambda { |uid, func, req|
   if func == 68
     puts "===== no idea to #{uid}: #{req.inspect}"
   elsif func == 67
@@ -45,12 +46,13 @@ server1.request_callback = ->(uid, func, req) do
     registers = Range.new(req[:addr], req[:addr] + req[:quant] - 1).zip(req[:val]).to_h
     puts Aurora.print_registers(registers)
   elsif [3, 65, 66].include?(func)
+    # no output
   else
     puts "**** new func #{func}"
   end
-end
+}
 
-server1.response_callback = ->(uid, func, res, req) do
+server1.response_callback = lambda { |uid, func, res, req|
   if func == 3 && res.is_a?(Array) && req
     unless req[:quant] == res.length
       puts "wrong number of results"
@@ -78,12 +80,13 @@ server1.response_callback = ->(uid, func, res, req) do
     registers = req.zip(res).to_h
     puts Aurora.print_registers(registers)
   elsif [16, 67, 68].include?(func)
+    # no output
   else
     puts "**** new func #{func}"
   end
-end
+}
 
 server2.start
 server1.send(:serve, server1.instance_variable_get(:@sp))
-#server1.start
-loop {}
+# server1.start
+loop { nil }

data/{bin → exe}/aurora_monitor

@@ -1,27 +1,28 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require 'aurora'
-require 'ccutrer-serialport'
-require 'socket'
-require 'uri'
+require "aurora"
+require "ccutrer-serialport"
+require "socket"
+require "uri"
 
 uri = URI.parse(ARGV[0])
 
 args = if uri.scheme == "telnet" || uri.scheme == "rfc2217"
-  require 'net/telnet/rfc2217'
-  [Net::Telnet::RFC2217.new('Host' => uri.host,
-    'Port' => uri.port || 23,
-    'baud' => 19200,
-    'parity' => Net::Telnet::RFC2217::EVEN)]
-else
-  [CCutrer::SerialPort.new(uri.path, baud: 19200, parity: :even)]
-end
+         require "net/telnet/rfc2217"
+         [Net::Telnet::RFC2217.new("Host" => uri.host,
+                                   "Port" => uri.port || 23,
+                                   "baud" => 19_200,
+                                   "parity" => Net::Telnet::RFC2217::EVEN)]
+       else
+         [CCutrer::SerialPort.new(uri.path, baud: 19_200, parity: :even)]
+       end
 
 server = ModBus::RTUServer.new(*args)
 server.promiscuous = true
 server.debug = true
 
-server.request_callback = ->(uid, func, req) do
+server.request_callback = lambda { |uid, func, req|
   if func == 68
     puts "===== no idea to #{uid}: #{req.inspect}"
   elsif func == 67
@@ -33,12 +34,13 @@ server.request_callback = ->(uid, func, req) do
     registers = Range.new(req[:addr], req[:addr] + req[:quant] - 1).zip(req[:val]).to_h
     puts Aurora.print_registers(registers)
   elsif [3, 65, 66].include?(func)
+    # no output
   else
     puts "**** new func #{func}"
   end
-end
+}
 
-server.response_callback = ->(uid, func, res, req) do
+server.response_callback = lambda { |uid, func, res, req|
   if func == 3 && res.is_a?(Array) && req
     unless req[:quant] == res.length
       puts "wrong number of results"
@@ -66,11 +68,12 @@ server.response_callback = ->(uid, func, res, req) do
     registers = req.zip(res).to_h
     puts Aurora.print_registers(registers)
   elsif [16, 67, 68].include?(func)
+    # no output
   else
     puts "**** new func #{func}"
   end
-end
+}
 
-require 'byebug'
+require "byebug"
 server.send(:serve, server.instance_variable_get(:@sp))
-loop {}
+loop { nil }

data/{bin → exe}/aurora_mqtt_bridge

@@ -1,22 +1,23 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require 'aurora'
-require 'homie-mqtt'
-require 'ccutrer-serialport'
-require 'uri'
+require "aurora"
+require "homie-mqtt"
+require "ccutrer-serialport"
+require "uri"
 
 uri = URI.parse(ARGV[0])
 mqtt_uri = ARGV[1]
 
 args = if uri.scheme == "telnet" || uri.scheme == "rfc2217"
-  require 'net/telnet/rfc2217'
-  [Net::Telnet::RFC2217.new('Host' => uri.host,
-    'Port' => uri.port || 23,
-    'baud' => 19200,
-    'parity' => Net::Telnet::RFC2217::EVEN)]
-else
-  [CCutrer::SerialPort.new(uri.path, baud: 19200, parity: :even)]
-end
+         require "net/telnet/rfc2217"
+         [Net::Telnet::RFC2217.new("Host" => uri.host,
+                                   "Port" => uri.port || 23,
+                                   "baud" => 19_200,
+                                   "parity" => Net::Telnet::RFC2217::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)
@@ -27,14 +28,15 @@ class MQTTBridge
     @homie = homie
     @mutex = Mutex.new
 
-    @homie.instance_variable_set(:@block, ->(topic, value) do
+    @homie.instance_variable_set(:@block, lambda do |topic, value|
       @mutex.synchronize do
         case topic
         when /\$modbus$/
-          query = value.split(',').map do |addr|
-            if addr == 'known'
+          query = value.split(",").map do |addr|
+            case addr
+            when "known"
               Aurora::REGISTER_NAMES.keys
-            elsif addr =~ /^(\d+)\.\.(\d+)$/
+            when /^(\d+)\.\.(\d+)$/
               Regexp.last_match(1).to_i..Regexp.last_match(2).to_i
             else
               addr.to_i
@@ -42,8 +44,8 @@ class MQTTBridge
           end
           queries = Aurora.normalize_ranges(query)
           registers = {}
-          queries.each do |query|
-            registers.merge!(@abc.modbus_slave.read_multiple_holding_registers(*query))
+          queries.each do |subquery|
+            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)
@@ -106,64 +108,62 @@ class MQTTBridge
     end
   end
 
-  def publish(topic, value)
-    @mqtt.publish("#{@base_topic}/#{topic}", value, true, 1)
-  end
-
-  def publish_attribute(attr, value)
-    if !@attributes.key?(attr) || @attributes[attr] != value
-      publish(attr, value.to_s)
-      @attributes[attr] = value
-    end
-  end
-
-  def subscribe(topic)
-    @mqtt.subscribe("#{@base_topic}/#{topic}")
-  end
-
   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("current-mode", "Current Heating/Cooling Mode", :enum, @abc.current_mode, format: %w[lockout standby blower h1 h2 c1 c2 eh1 eh2])
+      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")
-      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("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, unit: "ºF")
+      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,
+                    unit: "ºF")
       node.property("outdoor-temperature", "Outdoor Temperature", :float, @abc.outdoor_temperature, unit: "ºF")
-      node.property("relative-humidity", "Relative Humidity", :integer, @abc.relative_humidity, unit: "%", format: 0..100)
+      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")
     end
 
-    @abc.iz2_zones.each_with_index do |zone|
+    @abc.iz2_zones.each do |zone|
       @homie.node("zone#{zone.zone_number}", "Zone #{zone.zone_number}", "IntelliZone 2 Zone") do |node|
         allowed_modes = %w[off auto cool heat]
         allowed_modes << "eheat" if zone.zone_number == 1
-        node.property("target-mode", "Target Heating/Cooling Mode", :enum, zone.target_mode, format: allowed_modes) do |value, property|
+        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, format: %w[auto continuous intermittent]) do |value, property|
+        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,
+                      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|
+        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|
+        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
         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|
+        node.property("heating-target-temperature", "Heating Target Temperature", :integer,
+                      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|
+        node.property("cooling-target-temperature", "Cooling Target Temperature", :integer,
+                      zone.cooling_target_temperature, unit: "ºF", format: 54..99) do |value, property|
           @mutex.synchronize { property.value = zone.cooling_target_temperature = value }
         end
       end

data/lib/aurora/abc_client.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
+
 module Aurora
   class ABCClient
     attr_reader :modbus_slave,
-      :iz2_zones,
-      :current_mode,
-      :fan_speed,
-      :entering_air_temperature,
-      :relative_humidity,
-      :leaving_air_temperature,
-      :leaving_water_temperature,
-      :entering_water_temperature,
-      :dhw_water_temperature,
-      :waterflow,
-      :compressor_speed,
-      :outdoor_temperature,
-      :fp1,
-      :fp2
+                :iz2_zones,
+                :current_mode,
+                :fan_speed,
+                :entering_air_temperature,
+                :relative_humidity,
+                :leaving_air_temperature,
+                :leaving_water_temperature,
+                :entering_water_temperature,
+                :dhw_water_temperature,
+                :waterflow,
+                :compressor_speed,
+                :outdoor_temperature,
+                :fp1,
+                :fp2
 
     def initialize(modbus_slave)
       @modbus_slave = modbus_slave
@@ -25,12 +27,12 @@ module Aurora
     end
 
     def refresh
-      registers_to_read = [19..20, 30, 344, 740..741, 900, 1110..1111, 1114, 1117, 3027, 31003]
+      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 = 21203 + i * 9
-        base2 = 31007 + i * 3
-        base3 = 31200 + i * 3
+        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
@@ -48,27 +50,27 @@ module Aurora
       @dhw_water_temperature      = registers[1114]
       @waterflow                  = registers[1117]
       @compressor_speed           = registers[3027]
-      @outdoor_temperature        = registers[31003]
+      @outdoor_temperature        = registers[31_003]
       @fp1                        = registers[19]
       @fp2                        = registers[20]
       @locked_out                 = registers[1117]
 
       outputs = registers[30]
-      if outputs.include?(:lockout)
-        @current_mode = :lockout
-      elsif outputs.include?(:cc2)
-        @current_mode = outputs.include?(:rv) ? :c2 : :h2
-      elsif outputs.include?(:cc)
-        @current_mode = outputs.include?(:rv) ? :c1 : :h1
-      elsif outputs.include?(:eh2)
-        @current_mode = :eh2
-      elsif outputs.include?(:eh1)
-        @current_mode = :eh1
-      elsif outputs.include?(:blower)
-        @current_mode = :blower
-      else
-        @current_mode = :standby
-      end
+      @current_mode = if outputs.include?(:lockout)
+                        :lockout
+                      elsif outputs.include?(:cc2)
+                        outputs.include?(:rv) ? :c2 : :h2
+                      elsif outputs.include?(:cc)
+                        outputs.include?(:rv) ? :c1 : :h1
+                      elsif outputs.include?(:eh2)
+                        :eh2
+                      elsif outputs.include?(:eh1)
+                        :eh1
+                      elsif outputs.include?(:blower)
+                        :blower
+                      else
+                        :standby
+                      end
 
       iz2_zones.each do |z|
         z.refresh(registers)
@@ -76,7 +78,9 @@ module Aurora
     end
 
     def inspect
-      "#<Aurora::ABCClient #{(instance_variables - [:@modbus_slave]).map { |iv| "#{iv}=#{instance_variable_get(iv).inspect}" }.join(', ')}>"
+      "#<Aurora::ABCClient #{(instance_variables - [:@modbus_slave]).map do |iv|
+                               "#{iv}=#{instance_variable_get(iv).inspect}"
+                             end.join(', ')}>"
     end
   end
 end