waterfurnace_aurora 0.1.1 → 0.3.0

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.1.1'
+  VERSION = "0.3.0"
 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.1.1
+  version: 0.3.0
 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: mqtt
+  name: ccutrer-serialport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        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_mqtt_bridge

@@ -1,289 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'aurora'
-require 'mqtt'
-require 'ccutrer-serialport'
-require 'uri'
-
-uri = URI.parse(ARGV[0])
-mqtt_uri = URI.parse(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, mqtt_uri)
-    @base_topic = "homie/aurora"
-    @abc = abc
-    @mqtt = MQTT::Client.new(mqtt_uri)
-    @mqtt.set_will("#{@base_topic}/$state", "lost", true, 1)
-    @mqtt.connect
-    @attributes = {}
-    @mutex = Mutex.new
-
-    publish_basic_attributes
-
-    abc_thread = Thread.new do
-      loop do
-        begin
-          @mutex.synchronize do
-            @abc.refresh
-            publish_attribute("abc/compressor-speed", @abc.compressor_speed)
-            publish_attribute("abc/current-mode", @abc.current_mode)
-            publish_attribute("abc/dhw-water-temperature", @abc.dhw_water_temperature)
-            publish_attribute("abc/entering-air-temperature", @abc.entering_air_temperature)
-            publish_attribute("abc/entering-water-temperature", @abc.entering_water_temperature)
-            publish_attribute("abc/fan-speed", @abc.fan_speed)
-            publish_attribute("abc/leaving-air-temperature", @abc.leaving_air_temperature)
-            publish_attribute("abc/leaving-water-temperature", @abc.leaving_water_temperature)
-            publish_attribute("abc/outdoor-temperature", @abc.outdoor_temperature)
-            publish_attribute("abc/relative-humidity", @abc.relative_humidity)
-            publish_attribute("abc/waterflow", @abc.waterflow)
-            publish_attribute("abc/fp1", @abc.fp1)
-            publish_attribute("abc/fp2", @abc.fp2)
-
-            @abc.iz2_zones.each do |z|
-              i = z.zone_number
-              publish_attribute("zone#{i}/target-mode", z.target_mode)
-              publish_attribute("zone#{i}/current-mode", z.current_mode)
-              publish_attribute("zone#{i}/target-fan-mode", z.target_fan_mode)
-              publish_attribute("zone#{i}/current-fan-mode", z.current_fan_mode)
-              publish_attribute("zone#{i}/fan-intermittent-on", z.fan_intermittent_on)
-              publish_attribute("zone#{i}/fan-intermittent-off", z.fan_intermittent_off)
-              publish_attribute("zone#{i}/priority", z.priority)
-              publish_attribute("zone#{i}/size", z.size)
-              publish_attribute("zone#{i}/normalized-size", z.normalized_size)
-              publish_attribute("zone#{i}/ambient-temperature", z.ambient_temperature)
-              publish_attribute("zone#{i}/heating-target-temperature", z.heating_target_temperature)
-              publish_attribute("zone#{i}/cooling-target-temperature", z.cooling_target_temperature)
-            end
-          end
-        rescue => e
-          puts "got garbage: #{e}; #{e.backtrace}"
-          exit 1
-        end
-        sleep(5)
-      end
-    end
-
-    @mqtt.get do |topic, value|
-      puts "got #{value.inspect} at #{topic}"
-      zone = topic =~ %r{zone([1-6])/} && @abc.iz2_zones[$1.to_i - 1]
-
-      begin
-        @mutex.synchronize do
-          case topic
-          when %r{zone([1-6])/target-mode/set$}
-            publish_attribute("zone#{$1}/target-mode", zone.target_mode = value.to_sym)
-          when %r{zone([1-6])/target-fan-mode/set$}
-            publish_attribute("zone#{$1}/target-fan-mode", zone.target_fan_mode = value.to_sym)
-          when %r{zone([1-6])/fan-intermittent-(on|off)/set$}
-            publish_attribute("zone#{$1}/fan-intermittent-#{$2}", zone.send("fan_intermittent_#{$2}=", value.to_i))
-          when %r{zone([1-6])/(heating|cooling)-target-temperature}
-            publish_attribute("zone#{$1}/#{$2}-target-temperature", zone.send("#{$2}_target_temperature=", value.to_f))
-          when /\$modbus$/
-            query = value.split(',').map do |addr|
-              if addr == "known"
-                Aurora::REGISTER_NAMES.keys
-              elsif addr =~ /^(\d+)\.\.(\d+)$/
-                $1.to_i..$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)
-            @mqtt.publish("#{@base_topic}/$modbus/response", result, false, 1)
-          when %r{\$modbus/(\d+)$}
-            register = $1.to_i
-            value = case value
-            when /\d+/
-              value.to_i
-            when /0x(\d+)/
-              $1.to_i(16)
-            end
-            @abc.modbus_slave.holding_registers[register] = value if value
-          end
-        end
-      rescue => e
-        puts "failed processing message: #{e}\n#{e.backtrace}"
-      end
-    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
-    publish("$homie", "4.0.0")
-    publish("$name", "Aurora MQTT Bridge")
-    publish("$state", "init")
-    nodes = ["abc"]
-
-    publish("abc/$name", "Aurora Basic Control")
-    publish("abc/$datatype", "ABC")
-    publish("abc/$properties", "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")
-
-    publish("abc/compressor-speed/$name", "Compressor Speed")
-    publish("abc/compressor-speed/$datatype", "integer")
-    publish("abc/compressor-speed/$format", "0:12")
-
-    publish("abc/current-mode/$name", "Current Heating/Cooling Mode")
-    publish("abc/current-mode/$datatype", "enum")
-    publish("abc/current-mode/$format", "lockout,standby,blower,h1,h2,c1,c2,eh1,eh2")
-
-    publish("abc/dhw-water-temperature/$name", "DHW Water Temperature")
-    publish("abc/dhw-water-temperature/$datatype", "float")
-    publish("abc/dhw-water-temperature/$unit", "ºF")
-
-    publish("abc/entering-air-temperature/$name", "Entering Air Temperature")
-    publish("abc/entering-air-temperature/$datatype", "float")
-    publish("abc/entering-air-temperature/$unit", "ºF")
-
-    publish("abc/entering-water-temperature/$name", "Entering Water Temperature")
-    publish("abc/entering-water-temperature/$datatype", "float")
-    publish("abc/entering-water-temperature/$unit", "ºF")
-
-    publish("abc/fan-speed/$name", "Fan Speed")
-    publish("abc/fan-speed/$datatype", "integer")
-    publish("abc/fan-speed/$format", "0:11")
-
-    publish("abc/leaving-air-temperature/$name", "Leaving Air Temperature")
-    publish("abc/leaving-air-temperature/$datatype", "float")
-    publish("abc/leaving-air-temperature/$unit", "ºF")
-
-    publish("abc/leaving-water-temperature/$name", "Leaving Water Temperature")
-    publish("abc/leaving-water-temperature/$datatype", "float")
-    publish("abc/leaving-water-temperature/$unit", "ºF")
-
-    publish("abc/outdoor-temperature/$name", "Outdoor Temperature")
-    publish("abc/outdoor-temperature/$datatype", "float")
-    publish("abc/outdoor-temperature/$unit", "ºF")
-
-    publish("abc/relative-humidity/$name", "Relative Humidity")
-    publish("abc/relative-humidity/$datatype", "integer")
-    publish("abc/relative-humidity/$unit", "%")
-    publish("abc/relative-humidity/$format", "0:100")
-
-    publish("abc/waterflow/$name", "Waterflow")
-    publish("abc/waterflow/$datatype", "float")
-    publish("abc/waterflow/$unit", "gpm")
-
-    publish("abc/fp1/$name", "FP1 Sensor")
-    publish("abc/fp1/$datatype", "float")
-    publish("abc/fp1/$unit", "ºF")
-
-    publish("abc/fp2/$name", "FP1 Sensor")
-    publish("abc/fp2/$datatype", "float")
-    publish("abc/fp2/$unit", "ºF")
-
-    (1..@abc.iz2_zones.length).each do |i|
-      nodes << "zone#{i}"
-      publish("zone#{i}/$name", "Zone #{i}")
-      publish("zone#{i}/$datatype", "IntelliZone 2 Zone")
-      publish("zone#{i}/$properties", "target-mode,current-mode,target-fan-mode,current-fan-mode,fan-intermittent-on,fan-intermittent-off,priority,size,normalized-size,ambient-temperature,heating-target-temperature,cooling-target-temperature")
-
-      publish("zone#{i}/target-mode/$name", "Target Heating/Cooling Mode")
-      publish("zone#{i}/target-mode/$datatype", "enum")
-      if i == 1
-        publish("zone#{i}/target-mode/$format", "off,auto,cool,heat,eheat")
-      else
-        publish("zone#{i}/target-mode/$format", "off,auto,cool,heat")
-      end
-      publish("zone#{i}/target-mode/$settable", "true")
-      subscribe("zone#{i}/target-mode/set")
-
-      publish("zone#{i}/current-mode/$name", "Current Heating/Cooling Mode Requested")
-      publish("zone#{i}/current-mode/$datatype", "enum")
-      publish("zone#{i}/current-mode/$format", "standby,h1,h2,h3,c1,c2")
-
-      publish("zone#{i}/target-fan-mode/$name", "Target Fan Mode")
-      publish("zone#{i}/target-fan-mode/$datatype", "enum")
-      publish("zone#{i}/target-fan-mode/$format", "auto,continuous,intermittent")
-      publish("zone#{i}/target-fan-mode/$settable", "true")
-      subscribe("zone#{i}/target-fan-mode/set")
-
-      publish("zone#{i}/current-fan-mode/$name", "Current Fan Status")
-      publish("zone#{i}/current-fan-mode/$datatype", "boolean")
-
-      publish("zone#{i}/fan-intermittent-on/$name", "Fan Intermittent Mode On Duration")
-      publish("zone#{i}/fan-intermittent-on/$datatype", "enum")
-      publish("zone#{i}/fan-intermittent-on/$format", "0,5,10,15,20")
-      publish("zone#{i}/fan-intermittent-on/$unit", "M")
-      publish("zone#{i}/fan-intermittent-on/$settable", "true")
-      subscribe("zone#{i}/fan-intermittent-on/set")
-
-      publish("zone#{i}/fan-intermittent-off/$name", "Fan Intermittent Mode Off Duration")
-      publish("zone#{i}/fan-intermittent-off/$datatype", "enum")
-      publish("zone#{i}/fan-intermittent-off/$format", "0,5,10,15,20,25,30,35,40")
-      publish("zone#{i}/fan-intermittent-off/$unit", "M")
-      publish("zone#{i}/fan-intermittent-off/$settable", "true")
-      subscribe("zone#{i}/fan-intermittent-off/set")
-
-      publish("zone#{i}/priority/$name", "Zone Priority")
-      publish("zone#{i}/priority/$datatype", "enum")
-      publish("zone#{i}/priority/$format", "economy,comfort")
-
-      publish("zone#{i}/size/$name", "Size")
-      publish("zone#{i}/size/$datatype", "enum")
-      publish("zone#{i}/size/$format", "0,25,45,70")
-
-      publish("zone#{i}/normalized-size/$name", "Normalized Size")
-      publish("zone#{i}/normalized-size/$datatype", "integer")
-      publish("zone#{i}/normalized-size/$format", "0:100")
-      publish("zone#{i}/normalized-size/$unit", "%")
-
-      publish("zone#{i}/ambient-temperature/$name", "Ambient Temperature")
-      publish("zone#{i}/ambient-temperature/$datatype", "float")
-      publish("zone#{i}/ambient-temperature/$unit", "ºF")
-
-      publish("zone#{i}/heating-target-temperature/$name", "Heating Target Temperature")
-      publish("zone#{i}/heating-target-temperature/$datatype", "integer")
-      publish("zone#{i}/heating-target-temperature/$unit", "ºF")
-      publish("zone#{i}/heating-target-temperature/$format", "40:90")
-      publish("zone#{i}/heating-target-temperature/$settable", "true")
-      subscribe("zone#{i}/heating-target-temperature/set")
-
-      publish("zone#{i}/cooling-target-temperature/$name", "Cooling Target Temperature")
-      publish("zone#{i}/cooling-target-temperature/$datatype", "integer")
-      publish("zone#{i}/cooling-target-temperature/$unit", "ºF")
-      publish("zone#{i}/cooling-target-temperature/$format", "54:99")
-      publish("zone#{i}/cooling-target-temperature/$settable", "true")
-      subscribe("zone#{i}/cooling-target-temperature/set")
-    end
-    publish("$nodes", nodes.join(','))
-
-    # direct access to modbus registers for debugging purposes
-    subscribe("$modbus")
-    subscribe("$modbus/+")
-    publish("$state", 'ready')
-  end
-end
-
-MQTTBridge.new(abc, mqtt_uri)