waterfurnace_aurora 0.2.0 → 0.3.1

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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Aurora
-  VERSION = '0.2.0'
+  VERSION = "0.3.1"
 end

data/lib/aurora.rb

@@ -1,10 +1,13 @@
-require 'rmodbus'
+# frozen_string_literal: true
 
-require 'aurora/abc_client'
-require 'aurora/iz2_zone'
-require 'aurora/modbus/server'
-require 'aurora/modbus/slave'
-require 'aurora/registers'
+require "rmodbus"
+
+require "aurora/abc_client"
+require "aurora/iz2_zone"
+require "aurora/thermostat"
+require "aurora/modbus/server"
+require "aurora/modbus/slave"
+require "aurora/registers"
 
 # extend ModBus for WaterFurnace's custom functions
 ModBus::RTUServer.include(Aurora::ModBus::Server)

data/lib/waterfurnace_aurora.rb

@@ -1 +1,3 @@
-require 'aurora'
+# frozen_string_literal: true
+
+require "aurora"

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: waterfurnace_aurora
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire: 
-bindir: bin
+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: homie-mqtt
+  name: ccutrer-serialport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: net-telnet-rfc2217
+  name: homie-mqtt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 1.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 1.4.2
 - !ruby/object:Gem::Dependency
-  name: ccutrer-serialport
+  name: net-telnet-rfc2217
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 0.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: rmodbus-ccutrer
   requirement: !ruby/object:Gem::Requirement
@@ -81,51 +81,56 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '9.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: gserver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 0.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 0.0.1
 - !ruby/object:Gem::Dependency
-  name: gserver
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: '1.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: '1.19'
 description: 
 email: cody@cutrer.com'
 executables:
+- aurora_monitor
 - aurora_mqtt_bridge
+- aurora_mock
+- aurora_fetch
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/aurora_fetch
-- bin/aurora_mock
-- bin/aurora_monitor
-- bin/aurora_mqtt_bridge
-- bin/registers.yml
+- exe/aurora_fetch
+- exe/aurora_mock
+- exe/aurora_monitor
+- exe/aurora_mqtt_bridge
+- 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
@@ -140,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/bin/aurora_fetch

@@ -1,25 +0,0 @@
-#!/usr/bin/env ruby
-
-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' => 19200,
-    'parity' => Net::Telnet::RFC2217::EVEN)]
-else
-  [CCutrer::SerialPort.new(uri.path, baud: 19200, 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/aurora_monitor

@@ -1,76 +0,0 @@
-#!/usr/bin/env ruby
-
-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
-
-server = ModBus::RTUServer.new(*args)
-server.promiscuous = true
-server.debug = true
-
-server.request_callback = ->(uid, func, req) do
-  if func == 68
-    puts "===== no idea to #{uid}: #{req.inspect}"
-  elsif func == 67
-    puts "===== 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
-    puts Aurora.print_registers(registers)
-  elsif [3, 65, 66].include?(func)
-  else
-    puts "**** new func #{func}"
-  end
-end
-
-server.response_callback = ->(uid, func, res, req) do
-  if func == 3 && res.is_a?(Array) && req
-    unless req[:quant] == res.length
-      puts "wrong number of results"
-      next
-    end
-    puts "===== read registers from #{uid}"
-    registers = Range.new(req[:addr], req[:addr] + req[:quant], true).to_a.zip(res).to_h
-    puts Aurora.print_registers(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) }
-    unless register_list.length == res.length
-      puts "wrong number of results"
-      next
-    end
-    puts "===== read multiple register ranges from #{uid}"
-    result = register_list.zip(res).to_h
-    puts Aurora.print_registers(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}"
-    registers = req.zip(res).to_h
-    puts Aurora.print_registers(registers)
-  elsif [16, 67, 68].include?(func)
-  else
-    puts "**** new func #{func}"
-  end
-end
-
-require 'byebug'
-server.send(:serve, server.instance_variable_get(:@sp))
-loop {}

data/bin/aurora_mqtt_bridge

@@ -1,179 +0,0 @@
-#!/usr/bin/env ruby
-
-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
-
-slave = ModBus::RTUClient.new(*args).with_slave(1)
-abc = Aurora::ABCClient.new(slave)
-
-class MQTTBridge
-  def initialize(abc, homie)
-    @abc = abc
-    @homie = homie
-    @mutex = Mutex.new
-
-    @homie.instance_variable_set(:@block, ->(topic, value) do
-      @mutex.synchronize do
-        case topic
-        when /\$modbus$/
-          query = value.split(',').map do |addr|
-            if addr == 'known'
-              Aurora::REGISTER_NAMES.keys
-            elsif addr =~ /^(\d+)\.\.(\d+)$/
-              Regexp.last_match(1).to_i..Regexp.last_match(2).to_i
-            else
-              addr.to_i
-            end
-          end
-          queries = Aurora.normalize_ranges(query)
-          registers = {}
-          queries.each do |query|
-            registers.merge!(@abc.modbus_slave.read_multiple_holding_registers(*query))
-          end
-          result = Aurora.print_registers(registers)
-          @homie.mqtt.publish("#{@home.topic}/$modbus/response", result, retain: false, qos: 1)
-        when %r{\$modbus/(\d+)$}
-          register = Regexp.last_match(1).to_i
-          value = case value
-                  when /\d+/
-                    value.to_i
-                  when /0x(\d+)/
-                    Regexp.last_match(1).to_i(16)
-                  end
-          @abc.modbus_slave.holding_registers[register] = value if value
-        end
-      end
-    rescue StandardError => e
-      puts "failed processing message: #{e}\n#{e.backtrace}"
-    end)
-
-    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
-
-          @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
-          end
-        end
-      rescue => e
-        puts "got garbage: #{e}; #{e.backtrace}"
-        exit 1
-      end
-      sleep(5)
-    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("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("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("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("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|
-      @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|
-          @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|
-          @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 }
-        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
-        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|
-          @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|
-          @mutex.synchronize { property.value = zone.cooling_target_temperature = value }
-        end
-      end
-    end
-
-    # direct access to modbus registers for debugging purposes
-    @homie.mqtt.subscribe("#{@homie.topic}/$modbus")
-    @homie.mqtt.subscribe("#{@homie.topic}/$modbus/+")
-    @homie.publish
-  end
-end
-
-MQTTBridge.new(abc, MQTT::Homie::Device.new("aurora", "Aurora MQTT Bridge", mqtt: mqtt_uri))